Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

release module build workflow improvements / fixes #7619

Merged
merged 4 commits into from
Jan 16, 2024
Merged

release module build workflow improvements / fixes #7619

merged 4 commits into from
Jan 16, 2024

Conversation

jodygarnett
Copy link
Contributor

@jodygarnett jodygarnett commented Jan 13, 2024 •
edited
Loading

  • use the -Drelease flag so that optional modules are compiled and verified during QA
  • fix: add dependency from release to web so that release executed in the correct order
  • housekeeping: document use of mvn clean:clean@reset to remove jetty folder when changing branches
  • housekeeping: schemas uses SNAPSHOTs now, so extra step to clean up schmeas 3.8 is not needed
  • housekeeping: adjust web profile with-doc to add dependency so docs build first

Checklist

  • I have read the contribution guidelines
  • Pull request provided for main branch, backports managed with label
  • Good housekeeping of code, cleaning up comments, tests, and documentation
  • Clean commit history broken into understandable chucks, avoiding big commits with hundreds of files, cautious of reformatting and whitespace changes
  • Clean commit messages, longer verbose messages are encouraged
  • API Changes are identified in commit messages
  • Testing provided for features or enhancements using automatic tests
  • User documentation provided for new features or enhancements in manual
  • Build documentation provided for development instructions in README.md files
  • Library management using pom.xml dependency management. Update build documentation with intended library use and library tutorials or documentation
  • Funded by GeoCat BV by way of GeoNetwork Enterprise product (thank you customers!)

@jodygarnett jodygarnett changed the title some small build workflow improvements / fixes release module build workflow improvements / fixes Jan 15, 2024
@ianwallen
Copy link
Contributor

Why are you removing /web/src/main/webapp/doc/api? It is required by swagger pages?

@jodygarnett
Copy link
Contributor Author

Why are you removing /web/src/main/webapp/doc/api? It is required by swagger pages?

Sigh - yep managing generated content in a live src folder caught me out again (I am going to have to clean that up one of these days).

I will fix, thanks for the review.

@jodygarnett jodygarnett force-pushed the build_workflow_improvement branch 2 times, most recently from 72f244c to 3523aa9 Compare January 16, 2024 06:31
@jodygarnett
Copy link
Contributor Author

@josegar74 the build changes required for stable module order are starting to overlap with other pull-requests. Please accept this change (needed for automated builds to include release profile) which should keep things stable.

aside: We should plan to sit down and figure out what is where when so I do not repeat the same work in multiple PRs.

juanluisrp
juanluisrp approved these changes Jan 16, 2024
View reviewed changes
Copy link
Contributor

@juanluisrp juanluisrp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tested. LGTM.

@juanluisrp juanluisrp merged commit 44105b5 into geonetwork:main Jan 16, 2024
7 checks passed
juanluisrp pushed a commit that referenced this pull request Jan 16, 2024
@jodygarnett @juanluisrp
[BP] Build / release module build workflow improvements / fixes (#7619)
17b0700 
* schemas now uses `SNAPSHOTS`, no longer to manage schemas `3.8` explicitly.
* Remember to include `-Drelease` flag so that all modules (even optional modules) are compiled and tested during QA.
* Troubleshoot release module order of execution and profile activation and handling of jetty folder.
* Web profile with-doc profile needs dependency to build docs first.
---------

Signed-off-by: Jody Garnett <[email protected]>
@juanluisrp
Copy link
Contributor

juanluisrp commented Jan 16, 2024 •
edited
Loading

@jodygarnett I've backported this to 4.2.x branch, but it doesn't seem to work. Can you check it and do the backport to 3.12.x too?

https://github.com/geonetwork/core-geonetwork/actions/runs/7540881617/job/20526403544

@ianwallen ianwallen added this to the 4.4.2 milestone Jan 16, 2024
@jodygarnett
Copy link
Contributor Author

@juanluisrp I a confused about procedure / policy here. The instructions say to do commits with a single purpose clearly described, which makes back porting easier.

History: Clean commit messages and history: avoid big commits with hundreds of files, break commits up into understandable chunks, longer verbose commit messages are encouraged. Avoid reformatting and needless whitespace changes.

What is a good approach to get main / 4.2.x / 3.12.x on the same page?

@juanluisrp
Copy link
Contributor

AFAIK we squash and merge into main and then we backport the merge commit. I'm not aware of any changes in that procedure.

@jodygarnett jodygarnett mentioned this pull request Jan 16, 2024
Merged
@jodygarnett
Copy link
Contributor Author

The CONTIRBUTING guide has:

Rebase / Squash and merge: No merge commits with current branch, use Rebase or Squash and merge!

I guess I should have specified what was needed :)

@jodygarnett jodygarnett mentioned this pull request Jan 17, 2024
Merged
@juanluisrp juanluisrp mentioned this pull request Feb 29, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@juanluisrp juanluisrp juanluisrp approved these changes

@ianwallen ianwallen Awaiting requested review from ianwallen

Assignees
No one assigned
Labels
backport 3.12.x backport 4.2.x
Projects
None yet
Milestone
4.4.2
Development

Successfully merging this pull request may close these issues.
3 participants
@jodygarnett @ianwallen @juanluisrp