Skip to content

Commit

Permalink
Merge remote-tracking branch 'upstream/master' into derivatives
Browse files Browse the repository at this point in the history
  • Loading branch information
effigies committed May 17, 2019
2 parents 4a0506a + ddedf0c commit 75f4367
Show file tree
Hide file tree
Showing 8 changed files with 36 additions and 8 deletions.
17 changes: 13 additions & 4 deletions Release_Protocol.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This process is figured below ![Unreleased-to-Version](release_images/Unreleased

### 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")
This process is shown below ![dev-to-stable](release_images/site_name_release_1.2dev-1.2.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)
Expand All @@ -27,8 +27,17 @@ 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'
However, if it is determined we are not ready to release, please simply close the pull request.

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")
### 5. Edit the mkdocs.yml file site_name to set a new development version

However, if it is determined we are not ready to release, please simply close the pull request.
Please submit a PR with the title `REL: <version>-dev`.
This should be the first merged PR in the new version.
This process is illustrated below.

![stable-to-dev](release_images/site_name_release_1.2-1.3dev.png "stable-to-dev")

Note that the development version number should be larger than the last release, with the
version of the next *intended* release, followed by `-dev`.
For example, after the 1.3.0 release, either `1.3.1-dev` or `1.4.0-dev` would be reasonable, based
on the expected next version.
4 changes: 3 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
site_name: Brain Imaging Data Structure v1.2.0-dev
site_name: Brain Imaging Data Structure v1.3.0-dev
theme: material
extra_javascript:
- js/jquery-3.4.1.min.js
markdown_extensions:
- toc:
anchorlink: true
Expand Down
10 changes: 10 additions & 0 deletions readthedocs.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
version: 2

formats: all

build:
image: latest

python:
version: 3.6
install:
- requirements: requirements.txt

mkdocs:
configuration: mkdocs.yml
fail_on_warning: true
Binary file added release_images/site_name_release_1.2-1.3dev.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_release_1.2dev-1.2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 6 additions & 1 deletion src/99-appendices/02-licenses.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
# Appendix II: Licenses

This section lists a number of common licenses for datasets and defines
suggested abbreviations for use in the dataset metadata specifications
suggested abbreviations for use in the dataset metadata specifications.

Please note that this list only serves to provide some examples for possible
licenses.
The terms of any license should be consistent with the informed consent
obtained from participants and any institutional limitations on distribution.

| Identifier | License name | Description |
| :--------- | :----------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
Expand Down
4 changes: 2 additions & 2 deletions src/CHANGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@ Changelog

## [Unreleased](https://github.com/bids-standard/bids-specification/tree/HEAD)

- \[INFRA] Enable version panel for quickly finding previous versions [#232](https://github.com/bids-standard/bids-specification/pull/232) ([effigies](https://github.com/effigies))
- \[FIX] use \\&lt;label> for \_desc- - not some \\&lt;value> + clarify \\&lt;value> [#224](https://github.com/bids-standard/bids-specification/pull/224) ([yarikoptic](https://github.com/yarikoptic))
- \[FIX] Clarify Appendix II: The list of licenses only lists examples [#222](https://github.com/bids-standard/bids-specification/pull/222) ([sappelhoff](https://github.com/sappelhoff))
- \[FIX] Trivial column header fix [#220](https://github.com/bids-standard/bids-specification/pull/220) ([nicholst](https://github.com/nicholst))
- \[INFRA] Add clarification on merge methods to DECISION_MAKING [#217](https://github.com/bids-standard/bids-specification/pull/217) ([sappelhoff](https://github.com/sappelhoff))
- \[INFRA] Enable permalink urls to appear at (sub)section headings [#214](https://github.com/bids-standard/bids-specification/pull/214) ([yarikoptic](https://github.com/yarikoptic))
Expand Down Expand Up @@ -52,8 +54,6 @@ Changelog

## [v1.1.2](https://github.com/bids-standard/bids-specification/tree/v1.1.2) (2019-01-10)

## [v.1.1.2](https://github.com/bids-standard/bids-specification/tree/v.1.1.2) (2019-01-10)

- REL: v.1.1.2 [#121](https://github.com/bids-standard/bids-specification/pull/121) ([chrisgorgo](https://github.com/chrisgorgo))
- Update 01-contributors.md [#120](https://github.com/bids-standard/bids-specification/pull/120) ([oesteban](https://github.com/oesteban))
- Global fields in data dictionaries [#117](https://github.com/bids-standard/bids-specification/pull/117) ([chrisgorgo](https://github.com/chrisgorgo))
Expand Down
2 changes: 2 additions & 0 deletions src/js/jquery-3.4.1.min.js

Large diffs are not rendered by default.

0 comments on commit 75f4367

Please sign in to comment.