Skip to content

Commit

Permalink
chore: updates for release 2.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
coreone committed Jan 29, 2024
1 parent e51cd07 commit 3202f31
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 14 deletions.
13 changes: 11 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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:**

Expand Down
15 changes: 3 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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' \
Expand All @@ -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)
Expand Down

0 comments on commit 3202f31

Please sign in to comment.