From 55004d17242a29f7491a5147db5831ad238353a9 Mon Sep 17 00:00:00 2001 From: Remi Gau Date: Tue, 21 Nov 2023 11:47:18 +0100 Subject: [PATCH] [MAINT] Drop `dev` branch (#654) * remove mention master * remov mention dev and update CI * change mention of the dev branch * more doc updates * fix links * update CI --- .github/ISSUE_TEMPLATE/bug_report.yml | 1 - .github/dependabot.yml | 2 +- .github/workflows/run_examples.yml | 3 +-- .github/workflows/run_tests_matlab.yml | 3 +-- .github/workflows/run_tests_octave.yml | 3 +-- .github/workflows/update_schema.yml | 10 ++----- .github/workflows/validate.yml | 2 +- CONTRIBUTING.md | 5 ---- DECISION-MAKING.md | 37 +++----------------------- README.md | 29 +++++++++++--------- demos/README.md | 4 +-- docs/source/general_information.md | 22 ++++++++------- docs/source/layout_query.rst | 2 +- 13 files changed, 42 insertions(+), 81 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 453e9fb5..51716ea8 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -94,7 +94,6 @@ body: render: Markdown value: | - main 29b689dd - - dev 1bda0162 - type: textarea attributes: diff --git a/.github/dependabot.yml b/.github/dependabot.yml index b7843a10..b1bd1991 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -6,4 +6,4 @@ updates: - package-ecosystem: github-actions directory: / schedule: - interval: weekly + interval: monthly diff --git a/.github/workflows/run_examples.yml b/.github/workflows/run_examples.yml index d836ed40..a69606c3 100644 --- a/.github/workflows/run_examples.yml +++ b/.github/workflows/run_examples.yml @@ -9,8 +9,7 @@ concurrency: on: push: branches: - - master - - dev + - main pull_request: branches: ['*'] diff --git a/.github/workflows/run_tests_matlab.yml b/.github/workflows/run_tests_matlab.yml index e921b78a..f2490748 100644 --- a/.github/workflows/run_tests_matlab.yml +++ b/.github/workflows/run_tests_matlab.yml @@ -8,8 +8,7 @@ concurrency: on: push: branches: - - master - - dev + - main pull_request: branches: ['*'] diff --git a/.github/workflows/run_tests_octave.yml b/.github/workflows/run_tests_octave.yml index ecb165af..32c986b9 100644 --- a/.github/workflows/run_tests_octave.yml +++ b/.github/workflows/run_tests_octave.yml @@ -8,8 +8,7 @@ concurrency: on: push: branches: - - master - - dev + - main paths: - '**.m' pull_request: diff --git a/.github/workflows/update_schema.yml b/.github/workflows/update_schema.yml index 5485a1bd..5d118539 100644 --- a/.github/workflows/update_schema.yml +++ b/.github/workflows/update_schema.yml @@ -26,12 +26,6 @@ concurrency: cancel-in-progress: true on: - push: - branches: - - master - pull_request: - branches: - - master schedule: - cron: 0 0 * * 1 # every monday @@ -59,8 +53,8 @@ jobs: with: commit-message: BIDS schema update assignees: Remi-Gau - base: master + base: main token: ${{ secrets.PR_TOKEN }} delete-branch: true title: '[BOT] update schema' - body: done via this [GitHub Action](https://github.com/bids-standard/bids-matlab/blob/master/.github/workflows/update_schema.yml) + body: done via this [GitHub Action](https://github.com/bids-standard/bids-matlab/blob/main/.github/workflows/update_schema.yml) diff --git a/.github/workflows/validate.yml b/.github/workflows/validate.yml index 62f3dd1a..98db403e 100644 --- a/.github/workflows/validate.yml +++ b/.github/workflows/validate.yml @@ -7,7 +7,7 @@ concurrency: on: push: - branches: ['*'] + branches: main pull_request: branches: ['*'] diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 10505695..7827f916 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -240,11 +240,6 @@ Please detail the changes you are attempting to make. Please keep the title of your pull request short but informative. -It is important that your pull-request should target the development branch -(`dev`) of the BIDS-MATLAB parent repository: this is because we aim to keep the -stable version of the toolbox in the `main` branch and the latest version in the -`dev` branch. - Use one of the following prefixes in the title of your pull request: - `[ENH]` - enhancement of the software that adds a new feature or support for diff --git a/DECISION-MAKING.md b/DECISION-MAKING.md index f0e5f1b2..46cfd78b 100644 --- a/DECISION-MAKING.md +++ b/DECISION-MAKING.md @@ -62,7 +62,7 @@ and heavily depend on the 1. Does not feature any [Reviews that Request changes](https://help.github.com/articles/about-required-reviews-for-pull-requests/). 1. Does not feature "WIP" in the title (Work in Progress). - 1. Passes all automated tests and checks if the PR is aimed at the `main` branch. This means for example that some checks regarding styling or code quality are allowed will not prevent a merge if the PR is aimed at the `dev` branch see below for more details). + 1. Passes all automated tests and checks if the PR is aimed at the `main` branch. 1. Is not proposing a new release or has been approved by at least one Maintainer (that is, PRs proposing new releases need to be approved by at least one Maintainer). @@ -95,36 +95,5 @@ and heavily depend on the Version number follow semantic versioning. - - -The `main` branch holds the stable version of the toolbox. - -The `dev` branch is where the latest version can be fetched. - -Version bumps and new releases are triggered: - -- by hotfixes of bug -- by a merge of the develop branch in the main branch. - -A diagram version of the decision-making flow we are aiming for is shown below. ([source](https://blog.axosoft.com/gitflow/)) - -![git_flow](./docs/commenting_images/gitflow_diagram.png) - -#### Conditions for merge into `dev` - -We can accumulate a certain level of ["technical debt"](https://en.wikipedia.org/wiki/Technical_debt) on the development branch and therefore, we are more flexible as to what can be merged in there. - -Conditions: - -- All unit tests of code not changed in the PR must still pass. - - - -#### Conditions for merge into `main` - -Eventually though this technical debt must be paid back before a new release and merging into the main branch. - -Conditions: - -- All unit and integration tests must pass. -- All checks for code style and quality must pass. +The `main` branch is where the latest version can be fetched. +Stable versions should be fetched from a specific version tag. diff --git a/README.md b/README.md index 19cd0585..a2a09739 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,8 @@ [![tests_matlab](https://github.com/bids-standard/bids-matlab/actions/workflows/run_tests_matlab.yml/badge.svg)](https://github.com/bids-standard/bids-matlab/actions/workflows/run_tests_matlab.yml) [![tests_octave](https://github.com/bids-standard/bids-matlab/actions/workflows/run_tests_octave.yml/badge.svg)](https://github.com/bids-standard/bids-matlab/actions/workflows/run_tests_octave.yml) -[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/bids-standard/bids-matlab/dev?urlpath=demos) -[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/bids-standard/bids-matlab/dev.svg)](https://results.pre-commit.ci/latest/github/bids-standard/bids-matlab/dev) +[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/bids-standard/bids-matlab/main?urlpath=demos) +[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/bids-standard/bids-matlab/main.svg)](https://results.pre-commit.ci/latest/github/bids-standard/bids-matlab/main) [![miss hit](https://img.shields.io/badge/code%20style-miss_hit-000000.svg)](https://misshit.org/) [![View bids-matlab on File Exchange](https://www.mathworks.com/matlabcentral/images/matlab-file-exchange.svg)](https://nl.mathworks.com/matlabcentral/fileexchange/93740-bids-matlab) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.5910584.svg)](https://doi.org/10.5281/zenodo.5910584) @@ -50,8 +50,8 @@ a version of gunzip >= 1.6. Download, unzip this repository and add its content to the MATLAB/Octave path. ```Matlab -unzip('https://github.com/bids-standard/bids-matlab/archive/master.zip'); -addpath('bids-matlab-master'); +unzip('https://github.com/bids-standard/bids-matlab/archive/main.zip'); +addpath('bids-matlab-main'); ``` Or clone it with git: @@ -68,24 +68,29 @@ addpath('bids-matlab'); ### Get the latest features -The latest features of bids-matlab that are in development are in our `dev` -branch. +Stable versions should be fetched from a specific version tag. -To access them you can either download the `dev` branch from there: -https://github.com/bids-standard/bids-matlab/tree/dev +A new version of BIDS matlab should be released for each new version of the BIDS specification +to allow for a support of new BIDS datatypes or features. + +If you want the latest features of bids-matlab +that are in development are in our `main` branch. + +To access them you can either download the `main` branch from there: +https://github.com/bids-standard/bids-matlab/tree/main Or clone it: ```bash -git clone --branch dev https://github.com/bids-standard/bids-matlab.git +git clone --branch main https://github.com/bids-standard/bids-matlab.git ``` -Or you can check it out the `dev` branch after the adding this official -bids-matlab repository as a remote. +Or you can check it out the `main` branch +after the adding this official bids-matlab repository as a remote. ``` git add remote upstream https://github.com/bids-standard/bids-matlab.git -git checkout upstream/dev +git checkout upstream/main ``` ## Features diff --git a/demos/README.md b/demos/README.md index 10ef931e..16229539 100644 --- a/demos/README.md +++ b/demos/README.md @@ -1,8 +1,8 @@ ## Notebooks -[Tutorials](https://github.com/bids-standard/bids-matlab/blob/master/demos/notebooks/tutorial.ipynb) +[Tutorials](https://github.com/bids-standard/bids-matlab/blob/main/demos/notebooks/tutorial.ipynb) are available as a Jupyter Notebook to be run with Octave and that can be run interactively via -[Binder](https://mybinder.org/v2/gh/bids-standard/bids-matlab/dev?urlpath=demos). +[Binder](https://mybinder.org/v2/gh/bids-standard/bids-matlab/main?urlpath=demos). There is also `.m` script equivalent for each tutorial that can be run with MATLAB. diff --git a/docs/source/general_information.md b/docs/source/general_information.md index c30a2580..964d9f97 100644 --- a/docs/source/general_information.md +++ b/docs/source/general_information.md @@ -5,7 +5,7 @@ [![miss_hit](https://github.com/bids-standard/bids-matlab/actions/workflows/miss_hit.yml/badge.svg)](https://github.com/bids-standard/bids-matlab/actions/workflows/miss_hit.yml) [![tests_matlab](https://github.com/bids-standard/bids-matlab/actions/workflows/run_tests_matlab.yml/badge.svg)](https://github.com/bids-standard/bids-matlab/actions/workflows/run_tests_matlab.yml) [![tests_octave](https://github.com/bids-standard/bids-matlab/actions/workflows/run_tests_octave.yml/badge.svg)](https://github.com/bids-standard/bids-matlab/actions/workflows/run_tests_octave.yml) -[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/bids-standard/bids-matlab/dev?urlpath=demos) +[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/bids-standard/bids-matlab/main?urlpath=demos) [![View bids-matlab on File Exchange](https://www.mathworks.com/matlabcentral/images/matlab-file-exchange.svg)](https://nl.mathworks.com/matlabcentral/fileexchange/93740-bids-matlab) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.5910584.svg)](https://doi.org/10.5281/zenodo.5910584) [![All Contributors](https://img.shields.io/badge/all_contributors-13-orange.svg?style=flat-square)](#contributors-) @@ -31,8 +31,8 @@ See also [PyBIDS](https://github.com/bids-standard/pybids) for Python and the Download, unzip this repository and add its content to the MATLAB/Octave path. ```Matlab -unzip('https://github.com/bids-standard/bids-matlab/archive/master.zip'); -addpath('bids-matlab-master'); +unzip('https://github.com/bids-standard/bids-matlab/archive/main.zip'); +addpath('bids-matlab-main'); ``` Or clone it with git: @@ -49,18 +49,20 @@ addpath('bids-matlab'); ### Get the latest features -The latest features of bids-matlab that are in development are in our `dev` +Stable versions should be fetched from a specific version tag. + +The latest features of bids-matlab that are in development are in our `main` "branch". -To access them you can either download the `dev` branch from there: -https://github.com/bids-standard/bids-matlab/tree/dev +To access them you can either download the `main` branch from there: +https://github.com/bids-standard/bids-matlab/tree/main -Or you can check it out the `dev` branch after the adding this official +Or you can check it out the `main` branch after the adding this official bids-matlab repository as a remote. ``` git add remote upstream https://github.com/bids-standard/bids-matlab.git -git checkout upstream/dev +git checkout upstream/main ``` ## Features @@ -131,9 +133,9 @@ content = bids.util.jsondecode('/home/data/some_json_file.json'); ``` A -[tutorials](https://github.com/bids-standard/bids-matlab/blob/master/lib/bids-matlab/demos/notebooks) +[tutorials](https://github.com/bids-standard/bids-matlab/blob/main/lib/bids-matlab/demos/notebooks) are available as a Jupyter Notebooks and scripts and can be run interactively via -[Binder](https://mybinder.org/v2/gh/bids-standard/bids-matlab/dev?urlpath=demos). +[Binder](https://mybinder.org/v2/gh/bids-standard/bids-matlab/main?urlpath=demos). ## Requirements diff --git a/docs/source/layout_query.rst b/docs/source/layout_query.rst index 38ff2aef..177cb7b2 100644 --- a/docs/source/layout_query.rst +++ b/docs/source/layout_query.rst @@ -7,7 +7,7 @@ and then query the content of that dataset with :func:`bids.query`. The general API of these functions is detailed below. For an example on how to use them, check out -`this jupyter notebook `_. +`this jupyter notebook `_. .. automodule:: +bids