This repository contains a Sphinx project that gathers information from various project repos relating to the Open Government Canada tech stack, and stores their hashes in files. It also checks the difference of the hashes between this repo's release tags, and gathers change logs and comparison objects from the GitHub API.

When you are ready to deploy the code relating to the Open Government Canada project, you can tag this repository with a new release tag.

The tag should strictly follow the following date based format:

release/2024.05.07

OR (for same day)

release/2024.05.07.a
release/2024.05.07.b

OR (for pre release)

pre/2024.05.07

A GitHub workflow will run on tagging and generate the differences between all the related projects, compile the Sphinx project, and publish it to GitHub Pages. Pre releases will only display in GitHub Pages if it is the latest tag, otherwise they do not get displayed. Thus you can generate pre release notes with pre/2024.05.07 and share those notes; when you actually publish the code, you can tag with release/2024.05.07 which will replace the pre release display with the real release notes.

It is important to only tag from GitHub and not locally as pushing local tags may cause issues with syncing tags and the GitHub workflow.

1. Create a new release;
2. Under Choose a tag dropdown, make a new tag, following the above format;
3. Check Set as pre-release and Publish release;
4. We only want the tag really, and do not need the release ZIPs. So delete the release (the tag will remain).

If you built the release notes already and need to fix another project repo (e.g. missing change logs), you can manually fix it by deleting the related files for the release tag:

• docs/source/_release_builds/change_logs/<tag>.json
• docs/source/_release_builds/differences/<tag>.json
• docs/source/_release_builds/github/<tag>.json
• docs/source/_release_builds/releases/<tag>.json

Once you have done that, you can manually use the workflow_dispatch on the Build & Publish Release Notes GitHub Workflow.

If you made a mistake tagging this repo (e.g. incorrect release tag format), you can manually delete the tag and the related files above. Once you have done that, you can re-tag the repo and the GitHub Workflow will run again.