[REL] 0.3.1

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -82,6 +82,7 @@ body:
 
       Or check the content of CITATION.cff.
     options:
+    - v3.1.0
     - v3.0.0
     - v2.3.0
     - v2.2.0
@@ -95,6 +96,7 @@ body:
     - v1.1.0
     - v1.0.0
     - v0.2.0
+    - v0.1.1
     - v0.1.0
     - v0.0.3
     - v0.0.2

.gitignore

@@ -1,5 +1,7 @@
 lib/spmup
 
+docs/posters/2023_ohbm/poster/betterposter-thumbnail-portrait.png
+
 # General
 .DS_Store
 
@@ -9,6 +11,8 @@ lib/spmup
 *.html
 *.docx
 *.ps
+*.~lock.*
+*.ppt*
 
 new_events.tsv
 

.pre-commit-config.yaml

@@ -32,13 +32,14 @@ repos:
   - id: trailing-whitespace
   - id: end-of-file-fixer
   - id: check-yaml
-  - id: check-added-large-files
+  - id: check-json
+  # - id: check-added-large-files
 
 - repo: https://github.com/pre-commit/pygrep-hooks
   rev: v1.10.0
   hooks:
-  - id: rst-backticks     # Detect common mistake of using single backticks when writing rst
-  - id: rst-inline-touching-normal     # Detect mistake of inline code touching normal text in rst
+  - id: rst-backticks
+  - id: rst-inline-touching-normal
 
 - repo: https://github.com/psf/black
   rev: 23.3.0
@@ -108,11 +109,5 @@ repos:
   hooks:
   - id: codespell
 
-# - repo: https://github.com/tcort/markdown-link-check
-#   rev: v3.11.2
-#   hooks:
-#   - id: markdown-link-check
-#     args: [-q, -c, .github/workflows/mlc_config.json]
-
 ci:
   skip: [hadolint-docker]

CHANGELOG.md

@@ -19,9 +19,25 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Security
 -->
 
-## [Unreleased]
+<!-- ## [Unreleased]
 
-<!-- **Full Changelog**: https://github.com/cpp-lln-lab/bidspm/compare/v3.0.0...v3.1.0 -->
+
+### Added
+
+### Changed
+
+### Deprecated
+
+### Removed
+
+### Fixed
+
+### Security -->
+
+
+## [3.1.0] - 2023-07-01
+
+**Full Changelog**: https://github.com/cpp-lln-lab/bidspm/compare/v3.0.0...v3.1.0
 
 ### Added
 
@@ -49,8 +65,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * [ENH] overwrite files when renaming by default (#1051) @Remi-Gau
 * [ENH] turn error into warning when no data to copy found (#992) @Remi-Gau
 
-### Deprecated
-
 ### Removed
 
 * [ENH] drop rsHRF support (#906) @Remi-Gau

CITATION.cff

@@ -2,7 +2,7 @@ cff-version: 1.2.0
 
 title: "bidspm"
 
-version: 3.0.0
+version: 3.1.0
 
 abstract: bidspm is a set of pipelines and tools for Octave / MATLAB to process and analyze BIDS data sets using SPM12.
 
@@ -14,18 +14,21 @@ identifiers:
   - description: This is the collection of archived snapshots of all releases of bidspm
     type: doi
     value: "10.5281/zenodo.3554331"
+  - description: OHBM 2023 poster
+    type: doi
+    value: "10.5281/zenodo.8099835"
 
 contact:
   - affiliation: "Université catholique de Louvain"
-    email: remi.[email protected]
+    email: remi.[email protected]
     family-names: Gau
     given-names: Rémi
 
 authors:
 - family-names: "Gau"
   given-names: "Rémi"
   orcid: "https://orcid.org/0000-0002-1535-9767"
-  affiliation: "Université catholique de Louvain"
+  affiliation: "Origami lab, McGill University, Montreal, Québec, Canada"
 
 - family-names: "Barilari"
   given-names: "Marco"
@@ -42,11 +45,6 @@ authors:
   orcid: "https://orcid.org/0000-0002-1866-8645"
   affiliation: "Université catholique de Louvain"
 
-- family-names: "Collignon"
-  given-names: "Olivier"
-  orcid: "https://orcid.org/0000-0003-1882-3550"
-  affiliation: "Université catholique de Louvain"
-
 - family-names: "Gurtubay"
   given-names: "Ane"
   orcid: "https://orcid.org/0000-0003-3824-2219"
@@ -105,6 +103,12 @@ authors:
   affiliation: "Université catholique de Louvain"
   orcid: "https://orcid.org/0000-0001-9752-3294"
 
+- family-names: "Collignon"
+  given-names: "Olivier"
+  orcid: "https://orcid.org/0000-0003-1882-3550"
+  affiliation: "Université catholique de Louvain"
+
+
 license: GPL-3.0
 
 keywords:

CONTRIBUTING.md

@@ -98,3 +98,21 @@ created with:
 ```bash
 make update_faq
 ```
+
+### 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 docker recipes
+- [ ] update changelog
+- [ ] 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 tagged release
+- [ ] build and push docker images if necessary

README.md

@@ -234,17 +234,19 @@ Please see our
 
 ```bibtex
 @software{bidspm,
-  author = {Gau, Rémi and Barilari, Marco and Battal, Ceren and Rezk, Mohamed and Collignon, Olivier and Gurtubay, Ane and Falagiarda, Federica and MacLean, Michèle and Cerpelloni, Filippo and Shahzad, Iqra and Nunes, Márcia and Caron-Guyon, Jeanne and Chouinard-Leclaire, Christine and Yang, Ying, and Mattioni, Stefania},
+  author = {Gau, Rémi and Barilari, Marco and Battal, Ceren and Rezk, Mohamed and Collignon, Olivier and Gurtubay, Ane and Falagiarda, Federica and MacLean, Michèle and Cerpelloni, Filippo and Shahzad, Iqra and Nunes, Márcia and Caron-Guyon, Jeanne and Chouinard-Leclaire, Christine and Yang, Ying and Mattioni, Stefania and Van Audenhaege, Alice and Matuszewski, Jacek},
   license = {GPL-3.0},
-  title   = {bidspm},
+  title = {{bidspm}},
   url = {https://github.com/cpp-lln-lab/bidspm},
-  version = {3.0.0}
-  doi     = {10.5281/zenodo.3554331},
-  publisher = {Zenodo},
-  journal = {Software}
+  version = {3.1.0}
 }
 ```
 
+### Posters
+
+- [OHBM 2023](https://doi.org/10.5281/zenodo.8099835)
+
+
 ## Contributors
 
 Thanks goes to these wonderful people