Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ jobs:
- name: Set up Python
uses: actions/setup-python@v6
with:
python-version: "3.13"
python-version: "3.14"
- run: pip install tox

- name: Test Build
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ jobs:
- name: Set up Python
uses: actions/setup-python@v6
with:
python-version: "3.13"
python-version: "3.14"
- run: pip install tox gitpython

- name: Build docs
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ jobs:
- name: Set up Python
uses: actions/setup-python@v6
with:
python-version: "3.13"
python-version: "3.14"
- run: pip install tox

- name: Test Lint
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ jobs:
- name: setup Python
uses: actions/setup-python@v6
with:
python-version: "3.13"
python-version: "3.14"
- run: python -m pip install tox
- name: Build package
run: tox -e build
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ jobs:
strategy:
matrix:
platform: [ubuntu-latest, macos-latest, windows-latest]
python-version: ['3.11', '3.13']
python-version: ['3.11', '3.14']

steps:
- uses: actions/checkout@v6
Expand Down
3 changes: 3 additions & 0 deletions docs/CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ Changelog
Unreleased
----------

v0.1.34 (2025-12-02)
------------------------------------------

* Ignore ``.github`` workflows for changelog checks
* Ignore unrelated warnings from MDAnalysis
* Added ``argcomplete`` for tab completion
Expand Down
44 changes: 44 additions & 0 deletions docs/CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -160,3 +160,47 @@ are good to go (Pull Request).

.. _Tox: https://tox.readthedocs.io/en/latest/
.. _Fork this repository before contributing: https://github.com/MDAnalysis/mdacli/network/members

How to Perform a Release
-------------------------
1. **Prepare a Release Pull Request**

- Based on the main branch create branch ``release-0.1.35`` and a PR.
- Ensure that all `CI tests <https://github.com/MDAnalysis/mdacli/actions>`_ pass.
- Optionally, run the tests locally to double-check.

2. **Update the Changelog**

- Edit the changelog located in ``docs/CHANGELOG.rst``:
- Add a new section for the new version, summarizing the changes based on the
PRs merged since the last release.
- Leave a placeholder section titled *Unreleased* for future updates.

3. **Merge the PR and Create a Tag**

- Merge the release PR.
- Update the ``main`` branch and check that the latest commit is the release PR with
``git log``
- Create a tag on directly the ``main`` branch.
- Push the tag to GitHub. For example for a release of version ``2025.3``:

.. code-block:: bash

git checkout main
git pull
git tag -a v0.1.35 -m "Release v0.1.35"
git push --tags

4. **Finalize the GitHub Release**

- Once the PR is merged, the CI will automatically:
- Publish the package to PyPI.
- Create a draft release on GitHub.
- Update the GitHub release notes by pasting the changelog for the version.

5. **Merge Conda Recipe Changes**

- May resolve and then merge an automatically created PR on the `conda recipe
<https://github.com/conda-forge/mdacli-feedstock>`_.
- Once thus PR is merged and the new version will be published automatically on the
`conda-forge <https://anaconda.org/conda-forge/mdacli>`_ channel.