Merge pull request #287 from peter-evans/update-distribution

Update distribution

.github/workflows/ci.yml

@@ -2,8 +2,14 @@ name: CI
 on:
   push:
     branches: [master]
+    paths-ignore:
+      - 'README.md'
+      - 'docs/**'
   pull_request:
     branches: [master]
+    paths-ignore:
+      - 'README.md'
+      - 'docs/**'
 jobs:
   build:
     runs-on: ubuntu-latest
@@ -37,7 +43,7 @@ jobs:
         uses: actions/checkout@v2
         with:
           ref: ${{ github.head_ref }}
-      - if: matrix.target == 'built'
+      - if: matrix.target == 'built' || github.event_name == 'pull_request'
         uses: actions/download-artifact@v2
         with:
           name: dist
@@ -65,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
 

.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:

.github/workflows/update-dep.yml

@@ -0,0 +1,31 @@
+name: Update Dependencies
+on:
+  schedule:
+    - cron:  '0 1 * * 4'
+jobs:
+  update-dep:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+        with:
+          node-version: '12.x'
+      - name: Update dependencies
+        run: |
+          npx -p npm-check-updates ncu -u
+          npm install
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v2
+        with:
+            token: ${{ secrets.ACTIONS_BOT_TOKEN }}
+            commit-message: Update dependencies
+            committer: GitHub <noreply@github.com>
+            author: actions-bot <actions-bot@users.noreply.github.com>
+            title: Update dependencies
+            body: |
+              - Dependency updates
+  
+              Auto-generated by [create-pull-request][1]
+  
+              [1]: https://github.com/peter-evans/create-pull-request
+            branch: update-dependencies

README.md

@@ -1,4 +1,5 @@
 # <img width="24" height="24" src="docs/assets/logo.svg"> Create Pull Request
+[![CI](https://github.com/peter-evans/create-pull-request/workflows/CI/badge.svg)](https://github.com/peter-evans/create-pull-request/actions?query=workflow%3ACI)
 [![GitHub Marketplace](https://img.shields.io/badge/Marketplace-Create%20Pull%20Request-blue.svg?colorA=24292e&colorB=0366d6&style=flat&longCache=true&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAAOCAYAAAAfSC3RAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAM6wAADOsB5dZE0gAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAAERSURBVCiRhZG/SsMxFEZPfsVJ61jbxaF0cRQRcRJ9hlYn30IHN/+9iquDCOIsblIrOjqKgy5aKoJQj4O3EEtbPwhJbr6Te28CmdSKeqzeqr0YbfVIrTBKakvtOl5dtTkK+v4HfA9PEyBFCY9AGVgCBLaBp1jPAyfAJ/AAdIEG0dNAiyP7+K1qIfMdonZic6+WJoBJvQlvuwDqcXadUuqPA1NKAlexbRTAIMvMOCjTbMwl1LtI/6KWJ5Q6rT6Ht1MA58AX8Apcqqt5r2qhrgAXQC3CZ6i1+KMd9TRu3MvA3aH/fFPnBodb6oe6HM8+lYHrGdRXW8M9bMZtPXUji69lmf5Cmamq7quNLFZXD9Rq7v0Bpc1o/tp0fisAAAAASUVORK5CYII=)](https://github.com/marketplace/actions/create-pull-request)
 
 A GitHub action to create a pull request for changes to your repository in the actions workspace.
@@ -51,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.
@@ -71,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
@@ -143,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.
@@ -179,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:

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'

dist/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

dist/cpr/requirements.txt

@@ -1,4 +1,4 @@
-setuptools==46.1.3
+setuptools==46.2.0
 wheel==0.34.2
-GitPython==3.1.1
-PyGithub==1.50
+GitPython==3.1.2
+PyGithub==1.51

docs/concepts-guidelines.md

@@ -206,7 +206,7 @@ It will use their own fork to push code and create the pull request.
 3. Create a [Personal Access Token (PAT)](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line).
 4. Logout and log back in to your main user account.
 5. Add a secret to your repository containing the above PAT.
-6. As shown in the following example workflow, switch the git remote to the fork's URL after checkout and set the action input `request-on-parent` to `true`.
+6. As shown in the following example workflow, switch the git remote to the fork's URL after checkout and set the action input `request-to-parent` to `true`.
 
 ```yaml
       - uses: actions/checkout@v2
@@ -221,7 +221,7 @@ It will use their own fork to push code and create the pull request.
       - uses: peter-evans/create-pull-request@v2
         with:
           token: ${{ secrets.MACHINE_USER_PAT }}
-          request-on-parent: true
+          request-to-parent: true
 ```
 
 ### Running in a container

docs/examples.md

@@ -86,32 +86,62 @@ This pattern will work well for updating any kind of static content from an exte
 
 ### Update NPM dependencies
 
+This workflow will create a pull request for npm dependencies.
+It works best in combination with a build workflow triggered on `push` and `pull_request`.
+A [Personal Access Token (PAT)](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line) can be used in order for the creation of the pull request to trigger further workflows. See the [documentation here](https://github.com/peter-evans/create-pull-request/blob/master/docs/concepts-guidelines.md#triggering-further-workflow-runs) for further details.
+
 ```yml
 name: Update Dependencies
 on:
   schedule:
     - cron:  '0 10 * * 1'
 jobs:
-  update-deps:
+  update-dep:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v1
         with:
-          node-version: '10.x'
+          node-version: '12.x'
       - name: Update dependencies
-        id: vars
         run: |
-          npm install -g npm-check-updates
-          ncu -u
+          npx -p npm-check-updates ncu -u
           npm install
       - name: Create Pull Request
         uses: peter-evans/create-pull-request@v2
         with:
-          commit-message: update dependencies
-          title: Automated Dependency Updates
-          body: This is an auto-generated PR with dependency updates.
-          branch: dep-updates
+            token: ${{ secrets.PAT }}
+            commit-message: Update dependencies
+            title: Update dependencies
+            body: |
+              - Dependency updates
+  
+              Auto-generated by [create-pull-request][1]
+  
+              [1]: https://github.com/peter-evans/create-pull-request
+            branch: update-dependencies
+```
+
+The above workflow works best in combination with a build workflow triggered on `push` and `pull_request`.
+
+```yml
+name: CI
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 12.x
+      - run: npm ci
+      - run: npm run test
+      - run: npm run build
 ```
 
 ### Update SwaggerUI for GitHub Pages
@@ -243,7 +273,7 @@ An `on: repository_dispatch` workflow can be triggered from another workflow wit
 
 ```yml
 - name: Repository Dispatch
-  uses: peter-evans/repository-dispatch@v1.0.0
+  uses: peter-evans/repository-dispatch@v1
   with:
     token: ${{ secrets.REPO_ACCESS_TOKEN }}
     repository: username/my-repo

package.json

@@ -23,14 +23,14 @@
   },
   "homepage": "https://github.com/peter-evans/create-pull-request",
   "dependencies": {
-    "@actions/core": "1.2.0",
-    "@actions/exec": "1.0.2",
-    "@actions/tool-cache": "1.1.2",
+    "@actions/core": "1.2.4",
+    "@actions/exec": "1.0.4",
+    "@actions/tool-cache": "1.3.4",
     "is-docker": "2.0.0"
   },
   "devDependencies": {
     "@zeit/ncc": "0.22.1",
     "eslint": "6.8.0",
-    "jest": "25.5.3"
+    "jest": "26.0.1"
   }
 }

renovate.json

@@ -2,10 +2,8 @@
   "extends": [
     "config:base"
   ],
-  "packageRules": [
-    {
-      "depTypeList": ["devDependencies"],
-      "automerge": true
-    }
+  "enabledManagers": ["pip_requirements"],
+  "ignorePaths": [
+    "**/dist/**"
   ]
 }

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

src/cpr/requirements.txt

@@ -1,4 +1,4 @@
-setuptools==46.1.3
+setuptools==46.2.0
 wheel==0.34.2
-GitPython==3.1.1
-PyGithub==1.50
+GitPython==3.1.2
+PyGithub==1.51

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;