@@ -45,19 +45,22 @@ This information can also be extracted using the Github REST API.
4545
4646
4747## Creating a release
48- To create a new release,
48+ To create a new release:
49+
49501 . Make sure all requested functionality is merged with the ` develop ` branch.
50- 2 . From develop: ` git checkout -b release/[VERSION] ` . Example of version: ` 1.1.20231129 `
51- 3 . Update the version in ` pyproject.toml ` .
51+ 2 . Create a release branch from develop: ` git checkout -b release/[VERSION] ` . Example of version: ` 1.1.20231129 `
52+ 3 . Update the version in ` pyproject.toml ` on the release branch .
52534 . Test all (most of) the functionality. Checkout the project in a new directory and remove all
5354 your local images, and make sure it works out-of-the box.
54555 . Go to https://github.com/aiondemand/AIOD-rest-api/releases and draft a new release from the
55- release branch. Look at all closed PRs and create a changelog
56- 6 . Create a PR from release branch to master
57- 7 . After that's merged, create a PR from master to develop
58- 8 . Deploy on the server(s):
56+ release branch. Look at all closed PRs and create a changelog.
57+ 6 . Create a PR from release branch to develop. Make sure that when it is merged, the release branch is preserved.
58+ 7 . Deploy on the server(s):
5959 - Check which services currently work (before the update). It's a sanity check for if a service _ doesn't_ work later.
60- - Update the code on the server by checking out the release
61- - Merge configurations as necessary
60+ - Bring the services down.
61+ - Update the code on the server by checking out the release.
62+ - If the release contains new configuration options or configuration defaults, make sure that the override files are updated as needed.
63+ - Start the services without connectors.
6264 - Make sure the latest database migrations are applied: see [ "Schema Migrations"] ( schema/migration.md#update-the-database )
65+ - Restart the services with connectors.
63669 . Notify everyone (e.g., in the API channel in Slack).
0 commit comments