Skip to content

Commit

Permalink
minor updates to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Aaron Waggener committed Mar 6, 2023
1 parent 5ff0203 commit dbed596
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ This GitHub Action adds all open pull requests in an organization that are autho
## Inputs
Input Name | Required | Details
:-|:-:|:-
`organization` | | The URL friendly name of the organization (or repository owner) where the project board is located. If not specified, the action will default to the current organization where the action is being run.
`organization` | | The URL friendly name of the organization (or repository owner) where the pull requests and project board are located. If not specified, the action will default to the current organization where the action is being run.
`project-id` | :heavy_check_mark: | The numerical ID of the project where the pull requests will be added. This ID is typically found in the project URL "[organization-name]/projects/[*project-id*]"
`usernames` | :heavy_check_mark: | The GitHub usernames whose open pull requests will be added to the project board. The usernames should be separated by spaces. For example: octocat mona-lisa

## Environment Variables
This action uses the `gh` CLI tool to make graphql queries. In order for `gh` to authenticate properly, you need to create a Personal Access Token with `project`, `read:org`, and `repo` scopes. After generating the token, add it repository secrets, and then reference it in your actions workflow.
This action uses the `gh` CLI tool to make graphql queries. In order for `gh` to authenticate properly, you need to create a Personal Access Token with `project`, `read:org`, and `repo` scopes. After generating the token, add it to the repository secrets, and then reference it in your actions workflow.
```
env:
GH_TOKEN: ${{ secrets.GH_TOKEN }}
Expand All @@ -21,7 +21,7 @@ To use this action, include the following code in your workflow file:

```
- name: Add User PRs to a Project
uses: aaronwaggener/add-prs
uses: aaronwaggener/add-prs@1.0.0
with:
usernames: octocat mona-lisa
project-id: [project ID]
Expand All @@ -44,14 +44,14 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Add the PRs to the project
uses: aaronwaggener/add-prs
uses: aaronwaggener/add-prs@1.0.0
with:
usernames: octocat mona-lisa
usernames: [space separated list of usernames]
project-id: 123
organization: org-name
env:
GH_TOKEN: ${{ secrets.GH_TOKEN }}
```

## Triggers
This action was designed to run a `schedule`, but it can be used in any workflow regardless of the event trigger.
This action works best when run on a `schedule`, but it can be used in any workflow regardless of the event trigger.

0 comments on commit dbed596

Please sign in to comment.