Skip to content

Commit 6249475

Browse files
committed
Add release docs in Developer Guide
1 parent 284f42a commit 6249475

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

docs/developer_guide.rst

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -348,3 +348,30 @@ switcher. ``docs/_static/switcher.json`` must be manually updated to specify new
348348
that are too old, label a particular version as stable in the name, and identify which version is
349349
"preferred" for use in version warning banners. See
350350
:pydata-sphinx-theme:`PyData Sphinx theme user guide <user_guide>` for instructions and more information.
351+
352+
Making a Release
353+
----------------
354+
To make a release, follow these steps:
355+
1. Ensure that all changes are committed to the ``main`` branch.
356+
2. Update the version number in the ``package.json`` file.
357+
3. Add a new entry for the new version in the ``docs/_static/switcher.json`` file.
358+
4. Make a pull request to merge these changes to the ``main`` branch.
359+
5. Manually trigger the `build_and_deploy_mac` and `build_and_deploy_win` GitHub Actions to build the application.
360+
This will create a new draft release on GitHub with the updated version number and the built application files.
361+
6. Ensure all tests and workflows pass and request a review.
362+
7. Once the pull request is approved, merge it into the ``main`` branch.
363+
8. Create a new tag for the release using the format "v" followed by the version number in the ``package.json`` file.
364+
For example, if the version number is ``1.0.0``, you would create a tag called ``v1.0.0``. Push the changes.
365+
You can do this using the following command:
366+
.. code-block:: bash
367+
368+
git tag v1.0.0
369+
git push origin v1.0.0
370+
371+
9. Manually trigger the `build_and_deploy_mac` and `build_and_deploy_win` GitHub Actions to build the application.
372+
This will update the draft release on GitHub created in Step 5.
373+
10. Once the builds are complete, review the draft release to ensure everything is correct. Publish the release when
374+
ready.
375+
11. Check the ReadTheDocs build and ensure https://nwb-guide.readthedocs.io/ points to the new version.
376+
12. Check the install links on the main page of the documentation point to the new application files.
377+

0 commit comments

Comments
 (0)