diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 1560482..be3cf41 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -94,14 +94,14 @@ The release protocol can be briefly described as follows: version 1. Commit the change and git push to upstream `main`. Include "REL" in your commit message. -1. Then, make an annotated tag, for example for the version `1.2.3`: - `git tag -a -m "1.2.3" 1.2.3 upstream/main` +1. Then, make an annotated tag, for example for the version `v1.2.3`: + `git tag -a -m "v1.2.3" v1.2.3 upstream/main` (This assumes that you have a git remote configured with the name "upstream" and pointing to https://github.com/bids-standard/pybv). **NOTE: Make sure you have your `main` branch up to date for this step!** 1. `git push --follow-tags upstream` 1. Make a [release on GitHub](https://help.github.com/en/articles/creating-releases), - using the git tag from the previous step (e.g., `1.2.3`). + using the git tag from the previous step (e.g., `v1.2.3`). Fill the tag name into the "Release title" field, and fill the "Description" field as you see fit. 1. This will trigger a GitHub Action that will build the package and release it to PyPi. diff --git a/.github/workflows/cffconvert.yml b/.github/workflows/cffconvert.yml index 3874878..f0968dc 100644 --- a/.github/workflows/cffconvert.yml +++ b/.github/workflows/cffconvert.yml @@ -15,6 +15,9 @@ jobs: steps: - name: Check out a copy of the repository uses: actions/checkout@v4 + with: + fetch-depth: 0 + fetch-tags: true - name: Check whether the citation metadata from CITATION.cff is valid uses: citation-file-format/cffconvert-github-action@2.0.0 diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 18d302d..5927800 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -19,6 +19,9 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 + with: + fetch-depth: 0 + fetch-tags: true - uses: actions/setup-python@v5 with: python-version: '3.12' diff --git a/docs/changelog.rst b/docs/changelog.rst index 316185c..cd21df0 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -30,6 +30,13 @@ Here we list a changelog of pybv. :local: :depth: 1 +0.8.0 (unreleased) +================== + +Changelog +~~~~~~~~~ +- Nothing yet + 0.7.6 (2024-11-25) ==================