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.

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

Upgrade guidance for geonetwork 3 users #7644

Merged
merged 7 commits into from
Jan 22, 2024

Conversation

jodygarnett
Copy link
Contributor

Including mitigation guidance for removed services.

This is an action item from PSC meeting documenting the information from #4727 in the user manual.

I personally have questions after writing this documentation, but to stay on topic minimal guidance has been provided.

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

@jahow
Copy link
Contributor

jahow commented Jan 19, 2024

Thanks Jody, support for OAI PMH is coming soon with #7583 so we might not need to advertise it as not supported anymore

@jodygarnett
Copy link
Contributor Author

jodygarnett commented Jan 19, 2024

support for OAI PMH is coming soon with #7583 so we might not need to advertise it as not supported anymore

Thanks @jahow I have updated that page to indicate that there is interested.

- Includes mitigation guidance for removed serivces
- housekeeping: Address mkdocs warnings with due to changing emoji library
- change maven build to use --strict flag to prevent mkdoc regressions

Signed-off-by: Jody Garnett <jody.garnett@gmail.com>
@jodygarnett
Copy link
Contributor Author

All feedback has been addressed.

@josegar74 josegar74 added this to the 4.4.2 milestone Jan 22, 2024
@josegar74 josegar74 merged commit 5caefc0 into geonetwork:main Jan 22, 2024
7 checks passed
@geonetworkbuild
Copy link
Collaborator

The backport to 4.2.x failed:

The process '/usr/bin/git' failed with exit code 1
stderr
error: could not apply f3e8b00617... Upgrade guidance for geonetwork 3 users
hint: After resolving the conflicts, mark them with
hint: "git add/rm <pathspec>", then run
hint: "git cherry-pick --continue".
hint: You can instead skip this commit with "git cherry-pick --skip".
hint: To abort and get back to the state before "git cherry-pick",
hint: run "git cherry-pick --abort".

stdout
Auto-merging docs/manual/docs/api/search.md
CONFLICT (content): Merge conflict in docs/manual/docs/api/search.md
Auto-merging docs/manual/docs/install-guide/index.md
Auto-merging docs/manual/mkdocs.yml
Auto-merging docs/manual/pom.xml

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-4.2.x 4.2.x
# Navigate to the new working tree
cd .worktrees/backport-4.2.x
# Create a new branch
git switch --create backport-7644-to-4.2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick f3e8b006173c16e9a82ba9e7494b8f5cf7a90869,cc3fff572de6364880cf8acd0a1de3aca591a327,37a60589fe92f143406d3c73c18320b3c54a3c7c,9c36491ae875ed3d3d0a82c32907c33997c35c6d,367f21a811677121d3e43447c1feea2f2dcac659,c43d099d9d90338766ef4a8f5e1340d3ae054a6d,bd9b28de5ba5afe628790bff7300907f3a4f6fd9
# Push it to GitHub
git push --set-upstream origin backport-7644-to-4.2.x
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-4.2.x

Then, create a pull request where the base branch is 4.2.x and the compare/head branch is backport-7644-to-4.2.x.

josegar74 added a commit that referenced this pull request Jan 22, 2024
* Upgrade guidance for geonetwork 3 users

- Includes mitigation guidance for removed serivces
- housekeeping: Address mkdocs warnings with due to changing emoji library
- change maven build to use --strict flag to prevent mkdoc regressions

Signed-off-by: Jody Garnett <jody.garnett@gmail.com>

* Update docs/manual/docs/maintainer-guide/updating/index.md

* Update docs/manual/docs/maintainer-guide/updating/index.md

* Update docs/manual/docs/maintainer-guide/updating/index.md

* Update docs/manual/docs/maintainer-guide/updating/index.md

* Update docs/manual/docs/maintainer-guide/updating/index.md

* Update doc typos

---------

Signed-off-by: Jody Garnett <jody.garnett@gmail.com>
Co-authored-by: Jose García <josegar74@gmail.com>
@jodygarnett
Copy link
Contributor Author

@josegar74 I see the backport failed, and you manually back ported.

Thanks!

@jodygarnett jodygarnett deleted the update-api-clarifications branch January 22, 2024 17:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants