You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/developer.contributing.rst
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -158,7 +158,7 @@ When making a new release of Gambit, follow these steps:
158
158
2. Update the version number in the ``GAMBIT_VERSION`` file at the root of the repository to ``X.Y.Z``.
159
159
160
160
All other files will automatically use the updated version number:
161
-
161
+
162
162
- `pyproject.toml` reads from GAMBIT_VERSION file at build time
163
163
- `configure.ac` reads from GAMBIT_VERSION file and substitutes into `Info.plist` and `gambit.wxs`
164
164
- `src/pygambit/__init__.py` reads from installed package metadata or GAMBIT_VERSION file
@@ -168,18 +168,18 @@ When making a new release of Gambit, follow these steps:
168
168
3. Update the `ChangeLog` file with a summary of changes
169
169
170
170
4. Once there are no further commits to be made for the release, create a tag for the release from the latest commit on the maintenance branch. ::
171
-
171
+
172
172
git tag -a vX.Y.Z -m "Gambit version X.Y.Z"
173
173
174
174
5. Push the maintenance branch and tags to the GitHub repository. ::
175
-
175
+
176
176
git push origin maintX_Y
177
177
git push origin --tags
178
178
179
179
6. Create a new release on the `GitHub releases page <https://github.com/gambitproject/gambit/releases>`__, using the tag created in step 4.
180
180
Include a summary of changes from the `ChangeLog` file in the release notes.
181
181
182
-
7. Currently there is no automated process for pushing the new release to PyPI. This must be done manually by Ted Turocy or Rahul Savani.
182
+
7. Currently there is no automated process for pushing the new release to PyPI. This must be done manually.
183
183
184
184
.. TODO: update this process to be automated via GitHub Actions: Issue #557
185
185
@@ -191,4 +191,4 @@ If you have bug fixes that should be applied across maintained versions:
191
191
1. Make a branch from the oldest maintenance branch to which the change applies
192
192
2. Apply the change and make a pull request to that maintenance branch
193
193
3. After the pull request is merged, open new pull requests to each subsequent maintenance branch and finally to the master branch, merging each in turn
194
-
4. Create new releases from each maintenance branch as needed, following the steps in :ref:`making-a-new-release`.
194
+
4. Create new releases from each maintenance branch as needed, following the steps in :ref:`making-a-new-release`.
0 commit comments