Skip to content

Commit

Permalink
docs(readme): Add more info about the environment vars
Browse files Browse the repository at this point in the history
  • Loading branch information
n0th1ng-else committed Nov 16, 2021
1 parent 9556f55 commit 0625fe3
Showing 1 changed file with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# **semantic-release-pr-analyzer**

semantic-release plugin that imitates the behaviour when the team relies on the **_squash and merge_** strategy
on GitHub.

## Install

```bash
Expand Down Expand Up @@ -46,4 +49,20 @@ Always analyzes the pull request title and description as a commit.

### Strict Pull Request strategy (`{strategy: 'strict-pull-request'}`)

The same as the **_Pull Request strategy_**, but it will throw an error if the first commit body is not equal to the pull request description.
The same as the **_Pull Request strategy_**, but it will throw an error if the first commit body is not equal
to the pull request description.

## Environment variables

### env.GITHUB_TOKEN

GitHub token to access your repository. Using the `secrets.GITHUB_TOKEN` value should be enough.

### env.GITHUB_PR_NUMBER

The pull request number. In the context of GitHub actions, it is achievable as `github.event.pull_request.number`

### env.GITHUB_REPOSITORY

Repository path, for example `n0th1ng-else/semantic-release-pr-analyzer`. For GitHub actions workflow it is
set automatically.

0 comments on commit 0625fe3

Please sign in to comment.