From 3202f3143e8d5edd0b62a137c7c9199bda3c2c15 Mon Sep 17 00:00:00 2001 From: Andrew Teixeira Date: Mon, 29 Jan 2024 13:11:52 -0500 Subject: [PATCH] chore: updates for release 2.1.0 --- CHANGELOG.md | 13 +++++++++++-- README.md | 15 +++------------ 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index b62142e..c361205 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,8 +1,17 @@ # Changelog -## [2.0.1](https://github.com/broadinstitute/shared-workflows/tree/2.0.1) (2024-01-22) +## [2.1.0](https://github.com/broadinstitute/shared-workflows/tree/2.1.0) (2024-01-29) -[Full Changelog](https://github.com/broadinstitute/shared-workflows/compare/v2.0.0...2.0.1) +[Full Changelog](https://github.com/broadinstitute/shared-workflows/compare/v2.0.1...2.1.0) + +**Implemented enhancements:** + +- feat: add Ansible linter [\#37](https://github.com/broadinstitute/shared-workflows/pull/37) ([coreone](https://github.com/coreone)) +- feat: add ADR TOC check [\#36](https://github.com/broadinstitute/shared-workflows/pull/36) ([coreone](https://github.com/coreone)) + +## [v2.0.1](https://github.com/broadinstitute/shared-workflows/tree/v2.0.1) (2024-01-22) + +[Full Changelog](https://github.com/broadinstitute/shared-workflows/compare/v2.0.0...v2.0.1) **Implemented enhancements:** diff --git a/README.md b/README.md index 56e291f..1ec1a56 100644 --- a/README.md +++ b/README.md @@ -257,18 +257,6 @@ access token. We currently use for this purpose. The following should generate the file using information from GitHub: -```sh -docker run -it --rm \ - -e CHANGELOG_GITHUB_TOKEN='yourtokenhere' \ - -v "$(pwd)":/working \ - -w /working \ - githubchangeloggenerator/github-changelog-generator:latest --verbose -``` - -To generate the log for an upcoming release that has not yet been tagged, you -can run a command to include the upcoming release version. For example, -`2.0.0`: - ```sh docker run -it --rm \ -e CHANGELOG_GITHUB_TOKEN='yourtokenhere' \ @@ -279,6 +267,9 @@ docker run -it --rm \ --future-release 2.0.0 ``` +This will generate the log for an upcoming release of `2.0.0` that has not yet been +tagged. + As a note, this repository uses the default labels for formatting the `CHANGELOG.md`. Label information can be found here: [Advanced-change-log-generation-examples](https://github.com/github-changelog-generator/github-changelog-generator/wiki/Advanced-change-log-generation-examples#section-options)