Merge pull request #706 from SMI/release/v2.1.1

Release/v2.1.1

CHANGELOG.md

@@ -11,6 +11,25 @@ A raw git diff can be seen [here][unreleased].
 
 <!--next-->
 
+## [2.1.1] 2021-04-07
+
+## Bugfix
+
+-   [#697](https://github.com/SMI/SmiServices/pull/697) by rkm. Fixes #695.
+    Removes the checks preventing modality being specified with other extraction
+    keys
+-   [#698](https://github.com/SMI/SmiServices/pull/698) by rkm. CohortExtractor
+    database queries that crash during execution are now logged
+-   [#701](https://github.com/SMI/SmiServices/pull/701) by howff. Several
+    improvements to Python code for handling unusually-formatted SR documents.
+-   [#704](https://github.com/SMI/SmiServices/pull/704) by rkm. Fix
+    ReportNewLine being incorrectly set to a pre-escaped string. Fixes #703
+
+## Doc
+
+-   [#672](https://github.com/SMI/SmiServices/pull/672) by howff.
+    IsIdentifiableReviewer document updated
+
 ## [2.1.0] 2021-03-30
 
 ## Feature
@@ -773,7 +792,8 @@ First stable release after importing the repository from the private
 -   Anonymous `MappingTableName` must now be fully specified to pass validation
     (e.g. `mydb.mytbl`). Previously skipping database portion was supported.
 
-[unreleased]: https://github.com/SMI/SmiServices/compare/v2.1.0...master
+[unreleased]: https://github.com/SMI/SmiServices/compare/v2.1.1...master
+[2.1.1]: https://github.com/SMI/SmiServices/compare/v2.1.0...v2.1.1
 [2.1.0]: https://github.com/SMI/SmiServices/compare/v2.0.0...v2.1.0
 [2.0.0]: https://github.com/SMI/SmiServices/compare/v1.15.1...v2.0.0
 [1.15.1]: https://github.com/SMI/SmiServices/compare/v1.15.0...v1.15.1

README.md

@@ -8,7 +8,7 @@
 
 [![Total alerts](https://img.shields.io/lgtm/alerts/g/SMI/SmiServices.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/SMI/SmiServices/alerts/)
 
-Version: `2.1.0`
+Version: `2.1.1`
 
 # SMI Services
 

docs/RELEASING.md

@@ -8,6 +8,8 @@ The release worflow is to checkout a new `release/` branch from master, update t
 
 ## Creating A Normal Release
 
+-   Review all open PRs and check if any have been approved and can be merged to be included in the release.
+
 -   Check that a [news file][news_files] is present for each merged PR since the previous release. To do this, checkout the latest `master` commit and list all the merged PRs since the last release, e.g.:
     ```console
     $ git checkout master && git pull
@@ -47,7 +49,7 @@ The release worflow is to checkout a new `release/` branch from master, update t
     -   `README.md`: Bump the version in the header
     -   `src/SharedAssemblyInfo.cs`: Bump the versions in each property
 
--   Commit these changes and push the new branch with the message "Start release branch for v1.2.3"
+-   Commit these changes and push the new branch
 -   Open a PR for this branch with the title `Release <version>`. Request a review from `@tznind` and `@rkm`
 -   If there are any further changes which need to be included in the release PR, then these can be merged into the release branch from `master`
 -   Wait for the PR to be reviewed and merged
@@ -69,7 +71,6 @@ Hotfixes are small patches which are created in response to some show-stopper bu
 The process is similar to above, except:
 
 -   The branch name should be `hotfix/v...`
--   The commit message should be "Start hotfix branch for v1.2.3"
 -   The PR should be titled `Hotfix <version>`
 
 <!-- Links -->

news/README.md

@@ -27,6 +27,15 @@ Where `type` is one of
 -   `removal`
 -   `meta`
 
+*Note* Ensure that the file is named with the _PR_ number, rather than any associated _issue_ number.
+
+Quick tip: You can get the most recent issue or PR number with the following one-liner. Then add one to determine the new one for your PR (so long as you're quick!)
+
+```console
+$ curl -s "https://api.github.com/repos/smi/smiservices/issues?sort=created&direction=desc&per_page=1&page=1" | jq .[].number
+702
+```
+
 The file should contain a short description of the patch as one or more lines of markdown, either as a top-level sentence
 
 ```md

src/SharedAssemblyInfo.cs

@@ -7,6 +7,6 @@
 [assembly: AssemblyCulture("")]
 
 // These should be overwritten by release builds
-[assembly: AssemblyVersion("2.1.0")]
-[assembly: AssemblyFileVersion("2.1.0")]
-[assembly: AssemblyInformationalVersion("2.1.0")] // This one can have the extra build info after it
+[assembly: AssemblyVersion("2.1.1")]
+[assembly: AssemblyFileVersion("2.1.1")]
+[assembly: AssemblyInformationalVersion("2.1.1")] // This one can have the extra build info after it

utils/update-changelog.py

@@ -70,7 +70,8 @@ def _print_type_fragment(frag_type: str, fragments: Dict[str, Dict[int, str]]):
             print(line)
 
     # New features first
-    _print_type_fragment("feature", fragments)
+    if "feature" in fragments:
+        _print_type_fragment("feature", fragments)
 
     # Then the rest
     for frag_type in sorted(fragments):