Releasing deegree

Checklist

Tasks do be done when publishing a release version of deegree:

• create new milestone on github: https://github.com/deegree/deegree3/milestones/
• tag and label all merged PR for this milestone: use a query like is:pr is:merged merged:>2023-01-06, follow also Update GitHub pull requests
• run build job with SNAPSHOT build: https://buildserver.deegree.org/job/deegree-3.4-master/
• Continue when no error occurred!
• run build job with maven release: https://buildserver.deegree.org/job/deegree-3.4-master/
• verify that relevant artifacts have been uploaded to nexus: https://repo.deegree.org/repository/public/org/deegree/deegree-webservices/
• update Dockerfile to new version: https://github.com/deegree/deegree3-docker/blob/master/Dockerfile
• build docker image from Dockerfile
• locally test docker image as described in https://github.com/deegree/deegree3-docker/blob/master/README.md
• Continue when no fatal or unknown error occurred!
• create docker tag: https://github.com/deegree/deegree3-docker/tags
• push docker image to: https://hub.docker.com/r/deegree/deegree3-docker/
• create release from tag: https://github.com/deegree/deegree3-docker/releases
• publish documentation as described here
• create release from tag and upload artifacts WAR and PDF: https://github.com/deegree/deegree3/releases
• publish tag and use "auto-generate release notes"
• close milestone and add link to release tag
• update and publish website as described here
• update end-of-life matrix: https://github.com/deegree/deegree3/wiki/End-of-Life-and-Support-Matrix
• send email out to mailing lists as described here
• Send a tweet for #deegree_org at twitter: https://twitter.com/deegree_org

Update GitHub pull requests

Tag every merged pull request with "bug", "enhancement" or "feature". Remove other tags such as "in progress" or "contributions welcome" and assign it to the target milestone. For PR which have been rejected by TMC add flag "invalid", "duplicate" or "wontfix". Comment on rejected pull request as described in pull request response templates.

Run Jenkins jobs

NOTE: You need to be logged in to Jenkins, otherwise the relevant actions are not available.

In order to avoid the need for manual rollbacks, always run the deegree-*-master jobs as normal (non-release) jobs first and only to go on if these builds succeed:

• 3.4: Link -> "Build Now"

If build worked fine, perform the actual release:

• 3.4: Link -> "Perform Maven Release"

both with the default settings.

Attention: If a release build fails, clean up Jenkins before continuing:

• Log in to central.deegree.org via SSH. Become hudson: sudo su - hudson
• Change to checkout directory: cd /home/hudson/hudson-builds/{Jenkins Job}/workspace
• Check status: git status
• Remove untracked files: git clean -fd
• Revert changes: git reset --hard master (if commits have been made by release plugin, reset to specific commit)
• Remove tag if necessary: git tag -d {Release tag}
• Remove remote tag if necessary: git push origin/master :refs/tags/{Release tag}

Publish the handbook

Run build job: https://buildserver.deegree.org/view/misc/job/internal/job/publish-documentation with parameter RELEASE_VERSION=3.4.X

WORKAROUND: Login to central.deegree.org (ssh), then:

cd /var/www/download.deegree.org/documentation/
rm current
ln -s ./3.4.X ./current

NOTE: You need to exchange 3.4.X with the correct version.

Update homepage

• Clone the website https://github.com/deegree/deegree.github.io.git
• Update the main page: pages/pages-root-folder/index.md -> https://www.deegree.org/
• Update Download page: pages/download.md -> https://www.deegree.org/Download
• Update Documentation page: pages/documentation.md -> https://www.deegree.org/Documentation

Send release announcement

NOTE: adapt versions and links!

Subject: deegree webservices 3.4.X available

Body:

Dear deegree users,

we're happy to be able to announce new official deegree-webservices releases:

* New point release: 3.4.X *

- Download: http://www.deegree.org/Download
- Documentation: http://www.deegree.org/Documentation
- Changelog: https://github.com/deegree/deegree3/issues?milestone=X&state=closed

Enjoy!