Move the archives image in gitlab-docs and make it part of the docs release process
So, we're hosting the archives image in this project, but I believe it would be better to host it under gitlab-docs
. This way, we don't have to create two separate MRs to bump the versions.
The release process would go something like this:
- Around the 20th, build the archives image with a new version added to it. We can automate this so that it happens in a scheduled pipeline.
- On the 22nd that we merge the docs release MR, we kick a downstream pipeline to
gitlab-docs-archives
(will need to implement this ingitlab-docs
). - The pipeline runs here that uses the updated archives image from the 20th and uploads it to Pages.
Caveats
The archives deploy process takes almost two hours, so if the main docs site is deployed before the archives, we end up in a state where the version we remove from the prod site is not present in the archives. This could lead to 404s in case there's an instance that still uses that version.
We could deploy the archives site on the 21st to avoid this. We would end up with the version existing in both sites, but I believe that's a good compromise, and it would only happen once a month for a day or so.
Implementation
-
Add a job that manually builds the archives in gitlab-docs
Container Registry gitlab-docs!3779 (merged). -
Update the monthly docs release process to include the update of the archives Dockerfile and the manual run of the pipeline gitlab-docs!4591 (merged). -
Change how the build-version-list script is run, since the Dockerfile will be in the gitlab-docs
repo.
Edited by Achilleas Pipinellis