From 9316b0a20b1d5ebd926abf266c6928c5f00f5ace Mon Sep 17 00:00:00 2001 From: Rocco Meli Date: Mon, 31 Mar 2025 23:58:13 +0200 Subject: [PATCH 1/3] update --- doc/source/preparing_releases_and_hotfixes.rst | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/doc/source/preparing_releases_and_hotfixes.rst b/doc/source/preparing_releases_and_hotfixes.rst index 73d931a4..c9e32dd6 100644 --- a/doc/source/preparing_releases_and_hotfixes.rst +++ b/doc/source/preparing_releases_and_hotfixes.rst @@ -170,6 +170,9 @@ For now, the UserGuide is released at the same time as the core library. If it's cd doc/source/scripts python -m pytest tests/snapshot/ --snapshot-update +#. Define the ``GITHUB_TOKEN`` environment variable in with a GitHub personal access token that has the ``repo`` scope. + The access token is used by the script at the next step. + #. Make a Pull Request with a re-generated ``releases.md`` which contains a copy of the GitHub release notes. This can be generated by doing: .. code-block:: bash @@ -186,6 +189,8 @@ For now, the UserGuide is released at the same time as the core library. If it's #. This will automatically trigger a Github Action to build a new set of docs for that release and upload them. Due to the large size of the ``gh-pages`` branch on the UserGuide, this can be both slow and flaky, make sure to keep an eye out for any potential failures. +#. Follow the instructions in the `Clean up old development builds`_ section to remove old developer builds of the documentation. + Create a blog post outlining the release ---------------------------------------- @@ -205,10 +210,11 @@ Once the release is completed you can go ahead and update the ``develop`` branch #. Once these changes are merged into the ``develop`` branch, message the developers on discord and GitHub Discussions letting them know that the feature freeze is over. -Clean up old developer builds of the documentation --------------------------------------------------- +.. _Clean up old development builds: +Clean up old developement builds +-------------------------------- -Whilst new docs are automatically deployed on a release, old developer builds (appended with ``-dev``) are not automatically cleaned up. To avoid causing large amounts of files being uploaded to GitHub Pages, we need to delete these old developer builds manually. To do this switch to the ``gh-pages`` branch, delete these old files, and push the change directly. You should do this for both the core library and the UserGuide. +Whilst new docs are automatically deployed on a release, old developer builds (appended with ``-dev``) are not automatically cleaned up. To avoid causing large amounts of files being uploaded to GitHub Pages, we need to delete these old developer builds manually. To do this switch to the ``gh-pages`` branch, make sure it is up to date with upstream (i.e., run ``git pull`` ), delete the old files, and push the change directly. You should do this for both the core library and the UserGuide. While this is still a manual procedure, you should also edit `versions.json` to remove the old dev links. From 05dc8abf21e65b27ab95b953ff52ec7a5f4a12df Mon Sep 17 00:00:00 2001 From: Rocco Meli Date: Mon, 31 Mar 2025 23:59:08 +0200 Subject: [PATCH 2/3] Update doc/source/preparing_releases_and_hotfixes.rst --- doc/source/preparing_releases_and_hotfixes.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/source/preparing_releases_and_hotfixes.rst b/doc/source/preparing_releases_and_hotfixes.rst index c9e32dd6..682e81d4 100644 --- a/doc/source/preparing_releases_and_hotfixes.rst +++ b/doc/source/preparing_releases_and_hotfixes.rst @@ -170,7 +170,7 @@ For now, the UserGuide is released at the same time as the core library. If it's cd doc/source/scripts python -m pytest tests/snapshot/ --snapshot-update -#. Define the ``GITHUB_TOKEN`` environment variable in with a GitHub personal access token that has the ``repo`` scope. +#. Define the ``GITHUB_TOKEN`` environment variable with a GitHub personal access token that has the ``repo`` scope. The access token is used by the script at the next step. #. Make a Pull Request with a re-generated ``releases.md`` which contains a copy of the GitHub release notes. This can be generated by doing: From 1c3d2d709ab34e4596f70c5a173f60a220fc3f55 Mon Sep 17 00:00:00 2001 From: Rocco Meli Date: Tue, 1 Apr 2025 00:13:52 +0200 Subject: [PATCH 3/3] Update doc/source/preparing_releases_and_hotfixes.rst Co-authored-by: Lily Wang <31115101+lilyminium@users.noreply.github.com> --- doc/source/preparing_releases_and_hotfixes.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/source/preparing_releases_and_hotfixes.rst b/doc/source/preparing_releases_and_hotfixes.rst index 682e81d4..9caa310d 100644 --- a/doc/source/preparing_releases_and_hotfixes.rst +++ b/doc/source/preparing_releases_and_hotfixes.rst @@ -216,6 +216,8 @@ Clean up old developement builds Whilst new docs are automatically deployed on a release, old developer builds (appended with ``-dev``) are not automatically cleaned up. To avoid causing large amounts of files being uploaded to GitHub Pages, we need to delete these old developer builds manually. To do this switch to the ``gh-pages`` branch, make sure it is up to date with upstream (i.e., run ``git pull`` ), delete the old files, and push the change directly. You should do this for both the core library and the UserGuide. +In addition, update `versions.json` to remove the old `-dev` entry. + While this is still a manual procedure, you should also edit `versions.json` to remove the old dev links.