Skip to content

Commit

Permalink
Prep v2.1.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
bermannoah committed May 27, 2022
1 parent f8ae251 commit a595e6a
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 6 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Changelog

## v2.1.0

- Shows a relevant error when an issue is detected outside the current PR
- Does not run forever when there aren't any annotations (thanks @dlackty!)

## v2.0.0

- Adds direct comments to PRs and changes API interactions. Note that this may break implementations of the action that rely on previous functionality/API interactions.
Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ You can read more about Brakeman itself [here](https://github.com/presidentbeef/

This action helps make sure that brakeman results get accurately added to pull requests, in the event of a new issue.

Currently we recommend hardcoding the brakeman version (e.g. 5.2.1) to prevent the unintended consequences of pulling down the latest version
Currently we recommend hardcoding the brakeman version (e.g. 5.2.2) to prevent the unintended consequences of pulling down the latest version
regardless of context.

## Config options
Expand All @@ -23,7 +23,7 @@ These are the (required or recommended) options you can set for the runner.

```yml
- name: Brakeman
uses: cookpad/brakeman-linter-action@v2.0.0
uses: cookpad/brakeman-linter-action@v2.1.0
env:
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
```
Expand All @@ -33,12 +33,12 @@ These are the (required or recommended) options you can set for the runner.
```yml
- name: Install gems
run: |
gem install brakeman -v 5.2.1
gem install brakeman -v 5.2.2
- name: brakeman report
run: |
brakeman -f json > tmp/brakeman.json || exit 0
- name: Brakeman
uses: cookpad/brakeman-linter-action@v2.0.0
uses: cookpad/brakeman-linter-action@v2.1.0
env:
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
REPORT_PATH: tmp/brakeman.json
Expand All @@ -48,7 +48,7 @@ These are the (required or recommended) options you can set for the runner.
```yml
- name: Brakeman
uses: cookpad/brakeman-linter-action@v2.0.0
uses: cookpad/brakeman-linter-action@v2.1.0
env:
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
PROJECT_PATH: my_rails_app
Expand All @@ -67,7 +67,7 @@ jobs:
steps:
- uses: actions/checkout@v1
- name: Brakeman
uses: cookpad/brakeman-linter-action@v2.0.0
uses: cookpad/brakeman-linter-action@v2.1.0
env:
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
GITHUB_LATEST_SHA: ${{ github.event.pull_request.head.sha }}
Expand Down

0 comments on commit a595e6a

Please sign in to comment.