[REL] v0.3.0 (#725)

* update changelodg

* use deno validator

* do not validate during tests

* update doc

* update links in changelog

* add release protocol

* fix links

* fix

Author: Remi-Gau

.github/workflows/run_tests_matlab.yml

@@ -46,9 +46,12 @@ jobs:
         sudo apt-get -y -qq update
         sudo apt-get -y install unzip wget
 
+    - name: Install Deno
+      uses: denoland/setup-deno@v1
+      with:
+        deno-version: v1.x
     - name: Install bids validator
-      run: npm install -g bids-validator
-
+      run: deno install -Agf -n bids-validator jsr:@bids/validator
 
     - name: Install bids example
       run: |

.github/workflows/run_tests_octave.yml

@@ -40,8 +40,12 @@ jobs:
         sudo apt-get -y -qq update
         sudo apt-get -y install unzip wget
 
+    - name: Install Deno
+      uses: denoland/setup-deno@v1
+      with:
+        deno-version: v1.x
     - name: Install bids validator
-      run: npm install -g bids-validator
+      run: deno install -Agf -n bids-validator jsr:@bids/validator
 
     - name: Install bids-example
       run: |

CITATION.cff

@@ -4,7 +4,7 @@ cff-version: 1.2.0
 
 title: bids-matlab
 
-version: 0.2.0
+version: 0.3.0
 
 license: MIT
 

CONTRIBUTING.md

@@ -413,3 +413,25 @@ make update_schema
 A new version of the schema is fetched automatically regularly via continuous integration
 (see the [github action](.github/workflows/update_schema.yml)) when pushing to the repo
 or opening a pull-request.
+
+## release protocol
+
+- [ ] create a dedicated branch for the release candidate
+- [ ] update version in `citation.cff`
+- [ ] documentation related
+  - [ ] ensure the documentation is up to date
+  - [ ] make sure the doc builds correctly and fix any error
+- [ ] update jupyter books
+- [ ] update binder
+- [ ] update changelog
+  - [ ] change from `[unreleased]` to the version number
+  - [ ] remove unused sections (like `security`)
+- [ ] run `make release`
+- [ ] open a pull request (PR) from this release candidate branch targeting the default branch
+- [ ] fix any remaining failing continuous integration (test, markdown and code linting...)
+- [ ] merge to default branch
+- [ ] create a github tagged release
+- [ ] after release
+  - [ ] set version in `citation.cff` to dev
+  - [ ] update changelog
+    - [ ] add an `[unreleased]` section

Makefile

@@ -1,14 +1,16 @@
- .PHONY: clean manual
+.PHONY: clean manual
+
 clean:
 	rm version.txt
 
 version.txt: clean CITATION.cff
 	grep -w "^version" CITATION.cff | sed "s/version: /v/g" > version.txt
 
-manual:
-	cd docs && sh create_manual.sh
-
 update_schema:
 	wget https://bids-specification.readthedocs.io/en/latest/schema.json -O schema.json
 # get schema from a PR on the spec
 # wget https://bids-specification--1377.org.readthedocs.build/en/1377/schema.json -O schema.json
+
+release: version.txt
+	python docs/generate_doc.py
+	python docs/add_links_to_changelog.py

docs/__pycache__/utils.cpython-312.pyc

@@ -0,0 +1,28 @@
+# replace PR numbers and github usernames with links
+from __future__ import annotations
+
+import re
+
+from utils import root_dir
+
+change_log = root_dir() / "docs" / "source" / "changelog.md"
+
+with open(change_log) as f:
+    lines = f.readlines()
+
+with open(change_log, "w") as f:
+    for line in lines:
+        if match := re.search(r" @([a-zA-Z0-9_\-]+)", line):
+            username = match[1]
+            line = line.replace(
+                match[0], f" by [{username}](https://github.com/{username}) "
+            )
+
+        if match := re.search(r"\#([0-9]+)", line):
+            pr_number = match[1]
+            line = line.replace(
+                match[0],
+                f"[{pr_number}](https://github.com/bids-standard/bids-matlab/pull/{pr_number})",
+            )
+
+        f.write(line)