mirror of
https://github.com/Mailu/Mailu.git
synced 2024-12-14 10:53:30 +02:00
08be233607
2058: Implement versioning for CI/CD workflow. r=mergify[bot] a=Diman0
## What type of PR?
Feature!
## What does this PR do?
This PR introduces 3 things
- Add versioning (tagging) for branch x.y (1.8). E.g. 1.8.0, 1.8.1 etc.
- docker repo will contain x.y (latest) and x.y.z (pinned version) images.
- The X.Y.Z tag is incremented automatically. E.g. if 1.8.0 already exists, then the next merge on 1.8 will result in the new tag 1.8.1 being used.
- Make the version available in the image.
- For X.Y and X.Y.Z write the version (X.Y.Z) into /version on the image and add a label with version=X.Y.Z
- This means that the latest X.Y image shows the pinned version (X.Y.Z e.g. 1.8.1) it was based on. Via the tag X.Y.Z you can see the commit hash that triggered the built.
- For master write the commit hash into /version on the image and add a label with version={commit hash}
- Automatic releases. For x.y triggered builts (e.g. merge on 1.9) do a new github release for the pinned x.y.z (e.g. 1.9.2).
- Release shows a static message (see RELEASE_TEMPLATE.md) that explains how to reach the newsfragments folder and change the branch to the tag (x.y.z) mentioned in the release. Now you can get the changelog by reading all newsfragment files in this folder.
This PR does not change anything to our workflow (what we (human persons) do). Our processes are still exactly the same. The above introduced logic is automatic. When we backport to X.Y all the magic for creating the pinned version X.Y.Z is handled by the CI/CD workflow.
### Related issue(s)
- closes #1182
## Prerequisites
Before we can consider review and merge, please make sure the following list is done and checked.
If an entry in not applicable, you can check it or remove it from the list.
- [x] In case of feature or enhancement: documentation updated accordingly
- [x] Unless it's docs or a minor change: add [changelog](https://mailu.io/master/contributors/workflow.html#changelog) entry file.
## Testing
Suggested testing steps. This should cover all situations including BORS. It does require that you use your own docker repo or temporarily create a new one.
Suggested testing steps.
1. Create new github repo.
2. Add the required docker secrets to the project (see beginning of CI.yml for the secret names), DOCKER_UN, DOCKER_PW, DOCKER_ORG, DOCKER_ORG_TESTS.
3. Clone the project.
4. Copy the contents of the PR to the cloned project.
5. Push to your new github repo.
6. Now master images are built. Check that images with tag master are pushed to your docker repo
7. Check with docker inspect nginx:master that it has the label version={commit hash}.
8. Run an image, run `docker-compose exec <name> cat /version`. Note that /version also contains the pinned version. For master the pinned version is the commit hash.
9. Create branch 1.8.
10. Push branch 1.8 to repo.
11. Note that tags 1.8 and 1.8.0 are built and pushed to docker repo
12. Inspect label and /version. Note that 1.8 and 1.8.0 both show version 1.8.0.
13. Push another commit to branch 1.8.
14. Note that tags 1.8 and 1.8.1 are built and pushed to docker repo
15. Inspect label and /version. Note that 1.8 and 1.8.1 both show version 1.8.1.
16. Let's check BORS stuff.
17. Create branch testing.
18. Push the commit with the exact commit text (IMPORTANT!!): `Try #1234:`'.
19. Note that images are built and pushed for tag `pr-1234`.
20. Inspect label and /version. Note that the version is `pr-1234`.
20. Create branch staging.
21. Push the commit with commit text: `Merge #1234`.
22. Note that this image is not pushed to docker (as expected).
but you could also check the GH repo and docker repo I used:
https://github.com/Diman0/Mailu_Fork
https://hub.docker.com/r/diman/rainloop/tags
Co-authored-by: Dimitri Huisman <diman@huisman.xyz>
|
||
|---|---|---|
| .. | ||
| 116.feature | ||
| 224.enhancement | ||
| 224.feature | ||
| 360.bugfix | ||
| 466.feature | ||
| 470.doc | ||
| 783.feature | ||
| 1031.feature | ||
| 1037.doc | ||
| 1096.feature | ||
| 1154.enhancement | ||
| 1182.feature | ||
| 1194.bugfix | ||
| 1194.feature | ||
| 1223.bugfix | ||
| 1294.bugfix | ||
| 1503.doc | ||
| 1558.feature | ||
| 1567.feature | ||
| 1604.feature | ||
| 1607.feature | ||
| 1610.feature | ||
| 1612.feature | ||
| 1618.feature | ||
| 1638.fix | ||
| 1662.feature | ||
| 1669.bugfix | ||
| 1694.feature | ||
| 1696.misc | ||
| 1705.enhancement | ||
| 1712.misc | ||
| 1753.feature | ||
| 1760.bugfix | ||
| 1764.feature | ||
| 1798.feature | ||
| 1828.misc | ||
| 1830.misc | ||
| 1831.bugfix | ||
| 1851.feature | ||
| 1873.feature | ||
| 1917.bugfix | ||
| 1922.enhancement | ||
| 1926.feature | ||
| 1929.enhancement | ||
| 1952.bugfix | ||
| 1960.bugfix | ||
| 1962.bugfix | ||
| 1966.feature | ||
| 1990.bugfix | ||
| 1992.enhancement | ||
| 1996.enhancement | ||
| 2002.enhancement | ||
| 2007.enhancement | ||
| 2017.enhancement | ||
| 2079.fix | ||