Skip to content

Commit df21bbd

Browse files
committed
Update hub for GitHub Actions instructions
1 parent 1781a3e commit df21bbd

File tree

1 file changed

+9
-12
lines changed

1 file changed

+9
-12
lines changed

README.md

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -61,29 +61,26 @@ binary][latest] for your system and put it anywhere in your executable path.
6161

6262
#### GitHub Actions
6363

64-
hub can be used for automation through [GitHub Actions][] workflows:
64+
hub is ready to be used in your [GitHub Actions][] workflows:
6565
```yaml
6666
steps:
6767
- uses: actions/checkout@v2
6868

69-
- name: hub example
70-
shell: bash
71-
run: |
72-
curl -fsSL https://github.com/github/hub/raw/master/script/get | bash -s 2.14.1
73-
bin/hub pr list # list pull requests in the current repo
69+
- name: List open pull requests
70+
run: hub pr list
7471
env:
7572
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
7673
```
7774
78-
Note that the default GITHUB_TOKEN will only work for API operations within _the
79-
same repo that runs this workflow_. If you need to access or write to other
80-
repositories, [generate a Personal Access Token][pat] with `repo` scope and add
81-
it to your [repository secrets][].
75+
Note that the default `secrets.GITHUB_TOKEN` will only work for API operations
76+
scoped to the repository that runs this workflow. If you need to interact with other
77+
repositories, [generate a Personal Access Token][pat] with at least the `repo` scope
78+
and add it to your [repository secrets][].
8279

8380

84-
[github actions]: https://help.github.com/en/actions/automating-your-workflow-with-github-actions
81+
[github actions]: https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions
8582
[pat]: https://github.com/settings/tokens
86-
[repository secrets]: https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets
83+
[repository secrets]: https://docs.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets
8784

8885
#### Source
8986

0 commit comments

Comments
 (0)