diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 54952c1..12b5bac 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -71,7 +71,7 @@ jobs: - name: Close Pull uses: peter-evans/close-pull@v1 with: - pull-request-number: ${{ steps.cpr.outputs.pr_number }} + pull-request-number: ${{ steps.cpr.outputs.pull-request-number }} comment: '[CI] test ${{ matrix.target }}' delete-branch: true diff --git a/.github/workflows/cpr-example-command.yml b/.github/workflows/cpr-example-command.yml index bedb1ac..c1b7ba7 100644 --- a/.github/workflows/cpr-example-command.yml +++ b/.github/workflows/cpr-example-command.yml @@ -7,8 +7,10 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 + - name: Create report file run: date +%s > report.txt + - name: Create Pull Request id: cpr uses: ./ @@ -27,15 +29,15 @@ jobs: assignees: peter-evans reviewers: peter-evans milestone: 1 - project: Example Project - project-column: To do draft: false branch: example-patches request-to-parent: false + - name: Check outputs run: | echo "Pull Request Number - ${{ env.PULL_REQUEST_NUMBER }}" - echo "Pull Request Number - ${{ steps.cpr.outputs.pr_number }}" + echo "Pull Request Number - ${{ steps.cpr.outputs.pull-request-number }}" + - name: Add reaction uses: peter-evans/create-or-update-comment@v1 with: diff --git a/README.md b/README.md index ed206b3..35bb72e 100644 --- a/README.md +++ b/README.md @@ -52,15 +52,15 @@ All inputs are **optional**. If not set, sensible default values will be used. | `reviewers` | A comma separated list of reviewers (GitHub usernames) to request a review from. | | | `team-reviewers` | A comma separated list of GitHub teams to request a review from. A `repo` scoped [PAT](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line) may be required. See [this issue](https://github.com/peter-evans/create-pull-request/issues/155). | | | `milestone` | The number of the milestone to associate this pull request with. | | -| `project` | The name of the project for which a card should be created. Requires `project-column`. | | -| `project-column` | The name of the project column under which a card should be created. Requires `project`. | | +| `project` | *Deprecated*. See [Create a project card](#create-a-project-card) for details. | | +| `project-column` | *Deprecated*. See [Create a project card](#create-a-project-card) for details. | | | `draft` | Create a [draft pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests#draft-pull-requests). | `false` | | `branch` | The branch name. See [Branch naming](#branch-naming) for details. | `create-pull-request/patch` | | `request-to-parent` | Create the pull request in the parent repository of the checked out fork. See [push pull request branches to a fork](https://github.com/peter-evans/create-pull-request/blob/master/docs/concepts-guidelines.md#push-pull-request-branches-to-a-fork) for details. | `false` | | `base` | Sets the pull request base branch. | Defaults to the branch checked out in the workflow. | | `branch-suffix` | The branch suffix type. Valid values are `random`, `timestamp` and `short-commit-hash`. See [Branch naming](#branch-naming) for details. | | -**Outputs** +### Action outputs The pull request number is output as both an environment variable and a step output. Note that in order to read the step output the action step must have an id. @@ -72,7 +72,7 @@ Note that in order to read the step output the action step must have an id. - name: Check outputs run: | echo "Pull Request Number - ${{ env.PULL_REQUEST_NUMBER }}" - echo "Pull Request Number - ${{ steps.cpr.outputs.pr_number }}" + echo "Pull Request Number - ${{ steps.cpr.outputs.pull-request-number }}" ``` ### Checkout @@ -144,6 +144,23 @@ As well as relying on the action to handle uncommitted changes, you can addition uses: peter-evans/create-pull-request@v2 ``` +### Create a project card + +To create a project card for the pull request, pass the `pull-request-number` step output to [create-or-update-project-card](https://github.com/peter-evans/create-or-update-project-card) action. + +```yml + - name: Create Pull Request + id: cpr + uses: peter-evans/create-pull-request@v2 + + - name: Create or Update Project Card + uses: peter-evans/create-or-update-project-card@v1 + with: + project-name: My project + column-name: My column + issue-number: ${{ steps.cpr.outputs.pull-request-number }} +``` + ## Reference Example The following workflow is a reference example that sets all the main inputs. @@ -180,15 +197,13 @@ jobs: reviewers: peter-evans team-reviewers: owners, maintainers milestone: 1 - project: Example Project - project-column: To do draft: false branch: example-patches request-to-parent: false - name: Check outputs run: | echo "Pull Request Number - ${{ env.PULL_REQUEST_NUMBER }}" - echo "Pull Request Number - ${{ steps.cpr.outputs.pr_number }}" + echo "Pull Request Number - ${{ steps.cpr.outputs.pull-request-number }}" ``` This reference configuration will create pull requests that look like this: diff --git a/action.yml b/action.yml index f4483f6..21e8efa 100644 --- a/action.yml +++ b/action.yml @@ -27,9 +27,9 @@ inputs: milestone: description: 'The number of the milestone to associate this pull request with.' project: - description: 'The name of the project for which a card should be created.' + description: 'Deprecated. See README for details.' project-column: - description: 'The name of the project column under which a card should be created.' + description: 'Deprecated. See README for details.' branch: description: 'The pull request branch name.' request-to-parent: @@ -40,7 +40,7 @@ inputs: branch-suffix: description: 'The branch suffix type.' outputs: - pr_number: + pull-request-number: description: 'The pull request number' runs: using: 'node12' diff --git a/src/cpr/create_or_update_pull_request.py b/src/cpr/create_or_update_pull_request.py index de953a0..a34b090 100644 --- a/src/cpr/create_or_update_pull_request.py +++ b/src/cpr/create_or_update_pull_request.py @@ -113,6 +113,8 @@ def create_or_update_pull_request( # Set the output variables os.system(f"echo ::set-env name=PULL_REQUEST_NUMBER::{pull_request.number}") + os.system(f"echo ::set-output name=pull-request-number::{pull_request.number}") + # 'pr_number' is deprecated os.system(f"echo ::set-output name=pr_number::{pull_request.number}") # Set labels, assignees and milestone diff --git a/src/index.js b/src/index.js index 827ebad..fe422e9 100644 --- a/src/index.js +++ b/src/index.js @@ -64,7 +64,7 @@ async function run() { projectColumn: core.getInput("project-column"), draft: core.getInput("draft"), branch: core.getInput("branch"), - request_to_parent: core.getInput("request-to-parent"), + requestToParent: core.getInput("request-to-parent"), base: core.getInput("base"), branchSuffix: core.getInput("branch-suffix") }; @@ -87,7 +87,7 @@ async function run() { if (inputs.projectColumn) process.env.CPR_PROJECT_COLUMN_NAME = inputs.projectColumn; if (inputs.draft) process.env.CPR_DRAFT = inputs.draft; if (inputs.branch) process.env.CPR_BRANCH = inputs.branch; - if (inputs.request_to_parent) process.env.CPR_REQUEST_TO_PARENT = inputs.request_to_parent; + if (inputs.requestToParent) process.env.CPR_REQUEST_TO_PARENT = inputs.requestToParent; if (inputs.base) process.env.CPR_BASE = inputs.base; if (inputs.branchSuffix) process.env.CPR_BRANCH_SUFFIX = inputs.branchSuffix;