Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[MISC] Update site_name and release protocol #137

Merged
merged 2 commits into from
Feb 7, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions Release_Protocol.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,12 @@ Please make sure your fork is the most up to date version

This process is figured below ![Unreleased-to-Version](release_images/Unreleased-to-Version.png "Unreleased-to-Version")

### 3. Please open a pull request on the [master branch of the BIDS-specification](https://github.com/bids-standard/bids-specification/tree/master).
Important note: The pull request title **needs** to follow this protocol. REL: vX.X.X (i.e. REL: v1.1.2) There should only be one commit in the pull request (the step 2 commit)
### 3. Edit the mkdocs.yml file site_name version to the new version

This process is shown below ![dev-to-stable](release_images/site_name_2dev-3.png "dev-to-stable")

### 4. Please open a pull request on the [master branch of the BIDS-specification](https://github.com/bids-standard/bids-specification/tree/master).
Important note: The pull request title **needs** to follow this protocol. REL: vX.X.X (i.e. REL: v1.1.2). There could be one or two commits in the pull request (the step 2 and 3 changes)

### This will open a period of discussion for 5 business days regarding if we are ready to release. This will also freeze all pull request merging.

Expand All @@ -23,4 +27,8 @@ If we determine we are ready to release, please have the PR submitter add an add

![GH-release-3](release_images/GH-release_3.png "GH-release-3")

### 5. Edit the mkdocs.yml file site_name to append '-dev'

Please submit a PR with the title REL: site_name-dev. This should be the first merged PR in the new version. This process is illustrated below. ![stable-to-dev](release_images/site_name_3-3dev.png "stable-to-dev")

However, if it is determined we are not ready to release, please simply close the pull request.
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
site_name: Brain Imaging Data Structure
site_name: Brain Imaging Data Structure v1.1.2-dev
theme: material
plugins:
- search
Expand Down
Binary file added release_images/site_name_2dev-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added release_images/site_name_3-3dev.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.