Skip to content

Commit fe2ac2c

Browse files
committed
Update README
1 parent 3ca2188 commit fe2ac2c

File tree

1 file changed

+1
-15
lines changed

1 file changed

+1
-15
lines changed

README.md

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ A GitHub action to create a comment for a commit on GitHub.
1111
- name: Create commit comment
1212
uses: peter-evans/commit-comment@v1
1313
with:
14-
token: ${{ secrets.GITHUB_TOKEN }}
1514
body: |
1615
This is a multi-line test comment
1716
- With GitHub **Markdown**
@@ -22,7 +21,7 @@ A GitHub action to create a comment for a commit on GitHub.
2221
2322
## Parameters
2423
25-
- `token` (**required**) - The GitHub authentication token
24+
- `token` - The GitHub authentication token. Defaults to `GITHUB_TOKEN`.
2625
- `sha` - The commit SHA. Defaults to the current commit.
2726
- `body` (**required**) - The contents of the comment.
2827
- `path` - Relative path of the file to comment on.
@@ -48,19 +47,6 @@ Here is an example setting all of the input parameters.
4847
position: 1
4948
```
5049

51-
## Evaluating environment variables
52-
53-
Environment variables can be evaluated in the `body` input as follows.
54-
55-
```yml
56-
- name: Create commit comment
57-
uses: peter-evans/commit-comment@v1
58-
with:
59-
token: ${{ secrets.GITHUB_TOKEN }}
60-
body: |
61-
My env var: ${process.env.MY_ENV_VAR}
62-
```
63-
6450
## License
6551

6652
[MIT](LICENSE)

0 commit comments

Comments
 (0)