Merge pull request #105 from lukewar/graphql/projectv2

Update Action to use new ProjectsV2 api

README.md

@@ -9,9 +9,9 @@ not the original GitHub projects.
 
 [![build-test](https://github.com/actions/add-to-project/actions/workflows/test.yml/badge.svg)](https://github.com/actions/add-to-project/actions/workflows/test.yml)
 
-🚨 **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** 🚨
+> **NOTE:** This Action (currently) only supports auto-adding Issues/Pull Requests to a Project which lives in the same organization as your target Repository.
 
-> **NOTE:** This Action (currently) only supports auto-adding Issues to a Project which lives in the same organization as your target Repository.
+> **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).
 
 ## Usage
 
@@ -23,7 +23,9 @@ Create a workflow that runs when Issues or Pull Requests are opened or labeled i
 
 Once you've configured your workflow, save it as a `.yml` file in your target Repository's `.github/workflows` directory.
 
-##### Example Usage: Issue opened with labels `bug` OR `needs-triage`
+### Examples
+
+#### Example Usage: Issue opened with labels `bug` OR `needs-triage`
 
 ```yaml
 name: Add bugs to bugs project
@@ -38,15 +40,15 @@ jobs:
     name: Add issue to project
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/add-to-project@main
+      - uses: actions/add-to-project@RELEASE_VERSION
         with:
           project-url: https://github.com/orgs/<orgName>/projects/<projectNumber>
           github-token: ${{ secrets.ADD_TO_PROJECT_PAT }}
           labeled: bug, needs-triage
           label-operator: OR
 ```
 
-##### 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`
 
 ```yaml
 name: Adds all issues that don't include the 'bug' or 'needs-triage' labels to project board
@@ -61,15 +63,15 @@ jobs:
     name: Add issue to project
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/add-to-project@main
+      - uses: actions/add-to-project@RELEASE_VERSION
         with:
           project-url: https://github.com/orgs/<orgName>/projects/<projectNumber>
           github-token: ${{ secrets.ADD_TO_PROJECT_PAT }}
           labeled: bug, needs-triage
           label-operator: NOT
 ```
 
-##### Example Usage: Pull Requests labeled with `needs-review` and `size/XL`
+#### Example Usage: Pull Requests labeled with `needs-review` and `size/XL`
 
 ```yaml
 name: Add needs-review and size/XL pull requests to projects
@@ -84,30 +86,37 @@ jobs:
     name: Add issue to project
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/add-to-project@main
+      - uses: actions/add-to-project@RELEASE_VERSION
         with:
           project-url: https://github.com/orgs/<orgName>/projects/<projectNumber>
           github-token: ${{ secrets.ADD_TO_PROJECT_PAT }}
           labeled: needs-review, size/XL
           label-operator: AND
 ```
 
-#### Further reading and additional resources
-
-- [Inputs](#inputs)
-- [Supported Events](#supported-events)
-- [How to point the action to a specific branch or commit sha](#how-to-point-the-action-to-a-specific-branch-or-commit-sha)
-- [Creating a PAT and adding it to your repository](#creating-a-pat-and-adding-it-to-your-repository)
-- [Development](#development)
-- [Publish to a distribution branch](#publish-to-a-distribution-branch)
+### Further reading and additional resources
+
+- [actions/add-to-project](#actionsadd-to-project)
+  - [Current Status](#current-status)
+  - [Usage](#usage)
+    - [Examples](#examples)
+      - [Example Usage: Issue opened with labels `bug` OR `needs-triage`](#example-usage-issue-opened-with-labels-bug-or-needs-triage)
+      - [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)
+      - [Example Usage: Pull Requests labeled with `needs-review` and `size/XL`](#example-usage-pull-requests-labeled-with-needs-review-and-sizexl)
+    - [Further reading and additional resources](#further-reading-and-additional-resources)
+  - [Inputs](#inputs)
+  - [Supported Events](#supported-events)
+  - [Creating a PAT and adding it to your repository](#creating-a-pat-and-adding-it-to-your-repository)
+  - [Development](#development)
+  - [Publish to a distribution branch](#publish-to-a-distribution-branch)
+- [License](#license)
 
 ## Inputs
 
-- <a name="project-url">`project-url`</a> **(required)** is the URL of the GitHub project to add issues to.  
+- <a name="project-url">`project-url`</a> **(required)** is the URL of the GitHub project to add issues to.
   _eg: `https://github.com/orgs|users/<ownerName>/projects/<projectNumber>`_
 - <a name="github-token">`github-token`</a> **(required)** is a [personal access
-  token](https://github.com/settings/tokens/new) with the `repo`, `write:org` and
-  `read:org` scopes.  
+  token](https://github.com/settings/tokens/new) with `repo` and `project` scopes.
   _See [Creating a PAT and adding it to your repository](#creating-a-pat-and-adding-it-to-your-repository) for more details_
 - <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.
 - <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
 
 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.
 
-## How to point the action to a specific branch or commit sha
-
-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.
-
-```yaml
-jobs:
-  add-to-project:
-    name: Add issue to project
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/add-to-project@main
-        with:
-          project-url: https://github.com/orgs/<orgName>/projects/<projectNumber>
-          github-token: ${{ secrets.ADD_TO_PROJECT_PAT }}
-```
-
-Another option would be to point to a full [commit SHA](https://docs.github.com/en/get-started/quickstart/github-glossary#commit):
-
-```yaml
-jobs:
-  add-to-project:
-    name: Add issue to project
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/add-to-project@<commitSHA>
-        with:
-          project-url: https://github.com/orgs/<orgName>/projects/<projectNumber>
-          github-token: ${{ secrets.ADD_TO_PROJECT_PAT }}
-```
-
 ## Creating a PAT and adding it to your repository
 
 - create a new [personal access
-  token](https://github.com/settings/tokens/new) with `repo`, `write:org` and
-  `read:org` scopes  
+  token](https://github.com/settings/tokens/new) with `repo` and `project` scopes
   _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_
 
-- add the newly created PAT as a repository secret, this secret will be referenced by the [github-token input](#github-token)  
+- add the newly created PAT as a repository secret, this secret will be referenced by the [github-token input](#github-token)
   _See [Encrypted secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository) for more information_
 
 ## Development