You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
🚨**This action is in beta, however the API is stable. Some breaking changes might occur between versions, but it is not likely to break as long as you use a specific SHA or version number** 🚨
12
+
>**NOTE:**This Action (currently) only supports auto-adding Issues/Pull Requests to a Project which lives in the same organization as your target Repository.
13
13
14
-
> **NOTE:** This Action (currently) only supports auto-adding Issues to a Project which lives in the same organization as your target Repository.
14
+
> **NOTE:** This action no longer uses the deprecated ProjectNext API. If you are looking for the old version of that action, use version [v0.0.3](https://github.com/actions/add-to-project/releases/tag/v0.0.3).
15
15
16
16
## Usage
17
17
@@ -23,7 +23,9 @@ Create a workflow that runs when Issues or Pull Requests are opened or labeled i
23
23
24
24
Once you've configured your workflow, save it as a `.yml` file in your target Repository's `.github/workflows` directory.
25
25
26
-
##### Example Usage: Issue opened with labels `bug` OR `needs-triage`
26
+
### Examples
27
+
28
+
#### Example Usage: Issue opened with labels `bug` OR `needs-triage`
- [Example Usage: Issue opened with labels `bug` OR `needs-triage`](#example-usage-issue-opened-with-labels-bug-or-needs-triage)
104
+
- [Example Usage: Adds all issues opened that do not include the label `bug` OR `needs-triage`](#example-usage-adds-all-issues-opened-that-do-not-include-the-label-bug-or-needs-triage)
105
+
- [Example Usage: Pull Requests labeled with `needs-review` and `size/XL`](#example-usage-pull-requests-labeled-with-needs-review-and-sizexl)
106
+
- [Further reading and additional resources](#further-reading-and-additional-resources)
107
+
- [Inputs](#inputs)
108
+
- [Supported Events](#supported-events)
109
+
- [Creating a PAT and adding it to your repository](#creating-a-pat-and-adding-it-to-your-repository)
110
+
- [Development](#development)
111
+
- [Publish to a distribution branch](#publish-to-a-distribution-branch)
112
+
- [License](#license)
103
113
104
114
## Inputs
105
115
106
-
- <a name="project-url">`project-url`</a> **(required)** is the URL of the GitHub project to add issues to.
116
+
- <a name="project-url">`project-url`</a> **(required)** is the URL of the GitHub project to add issues to.
- <a name="github-token">`github-token`</a> **(required)** is a [personal access
109
-
token](https://github.com/settings/tokens/new) with the `repo`, `write:org` and
110
-
`read:org`scopes.
119
+
token](https://github.com/settings/tokens/new) with `repo` and `project` scopes.
111
120
_See [Creating a PAT and adding it to your repository](#creating-a-pat-and-adding-it-to-your-repository) for more details_
112
121
- <a name="labeled">`labeled`</a> **(optional)** is a comma-separated list of labels used to filter applicable issues. When this key is provided, an issue must have _one_ of the labels in the list to be added to the project. Omitting this key means that any issue will be added.
113
122
- <a name="labeled">`label-operator`</a> **(optional)** is the behavior of the labels filter, either `AND`, `OR` or `NOT` that controls if the issue should be matched with `all` `labeled` input or any of them, default is `OR`.
@@ -127,44 +136,13 @@ and the following [`pull_request` events](https://docs.github.com/en/actions/usi
127
136
128
137
Using these events ensure that a given issue or pull request, in the workflow's repo, is added to the [specified project](#project-url). If [labeled input(s)](#labeled) are defined, then issues will only be added if they contain at least _one_ of the labels in the list.
129
138
130
-
## How to point the action to a specific branch or commit sha
131
-
132
-
Pointing to a branch name generally isn't the safest way to refer to an action, but this is how you can use this action now before we've begun creating releases.
## Creating a PAT and adding it to your repository
161
140
162
141
- create a new [personal access
163
-
token](https://github.com/settings/tokens/new) with `repo`, `write:org` and
164
-
`read:org`scopes
142
+
token](https://github.com/settings/tokens/new) with `repo` and `project` scopes
165
143
_See [Creating a personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) for more information_
166
144
167
-
- add the newly created PAT as a repository secret, this secret will be referenced by the [github-token input](#github-token)
145
+
- add the newly created PAT as a repository secret, this secret will be referenced by the [github-token input](#github-token)
168
146
_See [Encrypted secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository) for more information_
0 commit comments