Skip to content

Commit

Permalink
continue dev
Browse files Browse the repository at this point in the history
  • Loading branch information
sappelhoff committed Nov 25, 2024
1 parent 20c36ed commit 68cb158
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 3 deletions.
6 changes: 3 additions & 3 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
3 changes: 3 additions & 0 deletions .github/workflows/cffconvert.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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/[email protected]
Expand Down
3 changes: 3 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down
7 changes: 7 additions & 0 deletions docs/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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)
==================

Expand Down

0 comments on commit 68cb158

Please sign in to comment.