From 811c16ee730275d196b0ad910157ee632460bd57 Mon Sep 17 00:00:00 2001 From: stephen scott tucker Date: Mon, 18 Jul 2022 15:44:30 -0400 Subject: [PATCH] Release v1.1 (#120) * `v1.0.1` -> `v1.1` Changed changelog to reflect the 2 number semver in use everywhere else --- CHANGELOG.md | 26 +++++++++++++------------- RELEASE.md | 6 +++--- snirf_specification.md | 2 +- 3 files changed, 17 insertions(+), 17 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 0f75701..da7723f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,9 +3,9 @@ SNIRF uses the [Semantic Versioning](https://semver.org) scheme. -### `1.0.1` In development +### `v1.1` -* Add dataUnit to indexed groups aux and measurementList +* Added dataUnit to indexed groups aux and measurementList * Uses of the word "numerical" were replaced with "numeric" for consistency. * stim/data was incorrectly described as `[,...]+` in the table when it should be `[[,...]]+` * aux/dataTimeSeries was incorrectly described as `[[,...]]+` in the table when it should be `[,...]+` @@ -19,22 +19,22 @@ SNIRF uses the [Semantic Versioning](https://semver.org) scheme. * Changed `/nirs(i)/data(j)/time` and `/nirs(i)/aux(j)/time` to specify the variable be stored as a rank-1 array, rather than a rank-2 array with a singleton trailing dimension. * Specified that `probe/sourceLabels` is 2D string array. In wavelength-less case, spec describes 2nd dimension of 1 * Specified that `aux{i}/dataTimeSeris` is a 2D array. Multiple channels of data can be present, otherwise 2nd dimension should be 1. -* Add language preventing `metaDataTags` sub-groups -* Add notice that the summary table is intended to be machine-readable +* Added language preventing `metaDataTags` sub-groups +* Added notice that the summary table is intended to be machine-readable -### `1.0` (September 23 2021) +### `v1.0` (September 23 2021) [View this version of the specification](https://github.com/fNIRS/snirf/blob/v1.0/snirf_specification.md) * General clarification of wording throughout the specification. -* Remove sourcePos, detectorPos, and landmarkPos. -* Add wavelengthActual and wavelengthEmissionActual. -* Change stim/data names from attribute to regular dataset. -* Require either 2D or 3D positions, not just 2D. -* Add list of supported aux name values including accel, gyro, magn -* Add datatypes for processed TD moment data. - -### `1.0 - Draft 3` (November 11 2019) +* Removed sourcePos, detectorPos, and landmarkPos. +* Added wavelengthActual and wavelengthEmissionActual. +* Changed stim/data names from attribute to regular dataset. +* Required either 2D or 3D positions, not just 2D. +* Added list of supported aux name values including accel, gyro, magn +* Added datatypes for processed TD moment data. + +### `v1.0 - Draft 3` (November 11 2019) [View this version of the specification](https://github.com/fNIRS/snirf/tree/da550abf7ec70084e31ba428df09a9dcbf3e6036) diff --git a/RELEASE.md b/RELEASE.md index 4f0a47d..d3d7bab 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -4,12 +4,12 @@ This document describes the process for releasing a new version of the SNIRF spe Only someone with write access to the `fNIRS/snirf` repository can complete this procedure. 1. Raise an issue at least one week prior to a planed release date to inform the community that a release is imminent. - Ensure that the issue clearly states the exact next proposed version number (e.g., `1.0`). + Ensure that the issue clearly states the exact next proposed version number (e.g., `v1.0`). 2. Ensure at least one other admin (someone with write access) agrees with the planned release, and confirms that there are no known blocking issues (open issues in the tracker are ok, but they should not be of critical nature). Approval should be provided as a comment in the issue, not via personal communication. 3. Open a pull request that makes the following modifications: - 1. Modify the version number in the opening lines of the specification to match the version to be released (e.g., `1.0`). + 1. Modify the version number in the opening lines of the specification to match the version to be released (e.g., `v1.0`). 4. Ensure at least one other admin approves the pull request, then it can be merged. 5. Create a new release and git tag by: 1. Press the `Create a new release` button on the repository home page. @@ -22,7 +22,7 @@ Only someone with write access to the `fNIRS/snirf` repository can complete this This will be something like https://github.com/fNIRS/snirf/blob/v1.0/snirf_specification.md 7. Modify the repository to indicate that it is now a development version by: 1. Increase the version number in the SNIRF specification and append the word "development" to it. E.g., `v1.1-development`. - This ensure that people can differentiate between released versions of the draft and work-in-progress versions. + This ensures that people can differentiate between released versions of the draft and work-in-progress versions. 2. Update the change log file by adding a link to the released version, specifying the release data, and adding the next development version. 8. Send an email out on the mailing list via: https://mailchi.mp/89a906ec22cf/snirf 9. Increase the version number listed on the Society for fNIRS website: https://fnirs.org/resources/software/snirf/ diff --git a/snirf_specification.md b/snirf_specification.md index 61669bd..bb0e6b5 100644 --- a/snirf_specification.md +++ b/snirf_specification.md @@ -1,7 +1,7 @@ Shared Near Infrared Spectroscopy Format (SNIRF) Specification ============================================================== -* **Document Version**: v1.1.0-development +* **Document Version**: v1.1 * **License**: This document is in the public domain. ## Table of Content