jiriks74/create-pull-request
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

v4 (#1099)

Browse source 
* feat: update action runtime to node 16

* feat: allow add-paths to resolve to no changes

* docs: update readme

* chore: update package lock

* chore: bump dependency

* ci: add dependabot workflow

* docs: update action versions
This commit is contained in:
Peter Evans 2022-03-23 14:22:01 +09:00 committed by GitHub
parent 0e8dfbd57d
commit d6d5519d05
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
15 changed files with 291 additions and 185 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
.github/dependabot.yml vendored Normal file
View file

@ -0,0 +1,8 @@
version: 2
updates:
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "weekly"
labels:
- "dependencies"

24
.github/workflows/ci.yml vendored
View file

@ -14,23 +14,21 @@ jobs:
build: build:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v3
- uses: actions/setup-node@v1 - uses: actions/setup-node@v2
with: with:
node-version: 12.x node-version: 16.x
- uses: actions/setup-python@v2 cache: npm
with:
python-version: '3.x'
- run: npm ci - run: npm ci
- run: npm run build - run: npm run build
- run: npm run format-check - run: npm run format-check
- run: npm run lint - run: npm run lint
- run: npm run test - run: npm run test
- uses: actions/upload-artifact@v2 - uses: actions/upload-artifact@v3
with: with:
name: dist name: dist
path: dist path: dist
- uses: actions/upload-artifact@v2 - uses: actions/upload-artifact@v3
with: with:
name: action.yml name: action.yml
path: action.yml path: action.yml
@ -43,16 +41,16 @@ jobs:
matrix: matrix:
target: [built, committed] target: [built, committed]
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v3
with: with:
ref: main ref: main
- if: matrix.target == 'built' || github.event_name == 'pull_request' - if: matrix.target == 'built' || github.event_name == 'pull_request'
uses: actions/download-artifact@v2 uses: actions/download-artifact@v3
with: with:
name: dist name: dist
path: dist path: dist
- if: matrix.target == 'built' || github.event_name == 'pull_request' - if: matrix.target == 'built' || github.event_name == 'pull_request'
uses: actions/download-artifact@v2 uses: actions/download-artifact@v3
with: with:
name: action.yml name: action.yml
path: . path: .
@ -112,8 +110,8 @@ jobs:
needs: [test] needs: [test]
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v3
- uses: actions/download-artifact@v2 - uses: actions/download-artifact@v3
with: with:
name: dist name: dist
path: dist path: dist

2
.github/workflows/cpr-example-command.yml vendored
View file

@ -6,7 +6,7 @@ jobs:
createPullRequest: createPullRequest:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v3
- name: Make changes to pull request - name: Make changes to pull request
run: date +%s > report.txt run: date +%s > report.txt

29
README.md
View file

@ -21,20 +21,20 @@ Create Pull Request action will:
- [Concepts, guidelines and advanced usage](docs/concepts-guidelines.md) - [Concepts, guidelines and advanced usage](docs/concepts-guidelines.md)
- [Examples](docs/examples.md) - [Examples](docs/examples.md)
- [Updating to v3](docs/updating.md) - [Updating to v4](docs/updating.md)
## Usage ## Usage
```yml ```yml
- uses: actions/checkout@v2 - uses: actions/checkout@v3
# Make changes to pull request here # Make changes to pull request here
- name: Create Pull Request - name: Create Pull Request
uses: peter-evans/create-pull-request@v3 uses: peter-evans/create-pull-request@v4
``` ```
You can also pin to a [specific release](https://github.com/peter-evans/create-pull-request/releases) version in the format `@v3.x.x` You can also pin to a [specific release](https://github.com/peter-evans/create-pull-request/releases) version in the format `@v4.x.x`
### Action inputs ### Action inputs
@ -46,7 +46,7 @@ All inputs are **optional**. If not set, sensible defaults will be used.
| --- | --- | --- | | --- | --- | --- |
| `token` | `GITHUB_TOKEN` (permissions `contents: write` and `pull-requests: write`) or a `repo` scoped [Personal Access Token (PAT)](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token). | `GITHUB_TOKEN` | | `token` | `GITHUB_TOKEN` (permissions `contents: write` and `pull-requests: write`) or a `repo` scoped [Personal Access Token (PAT)](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token). | `GITHUB_TOKEN` |
| `path` | Relative path under `GITHUB_WORKSPACE` to the repository. | `GITHUB_WORKSPACE` | | `path` | Relative path under `GITHUB_WORKSPACE` to the repository. | `GITHUB_WORKSPACE` |
| `add-paths` | A comma or newline-separated list of file paths to commit. Paths should follow git's [pathspec](https://git-scm.com/docs/gitglossary#Documentation/gitglossary.txt-aiddefpathspecapathspec) syntax. Defaults to adding all new and modified files. See [Add specific paths](#add-specific-paths). | `-A` | | `add-paths` | A comma or newline-separated list of file paths to commit. Paths should follow git's [pathspec](https://git-scm.com/docs/gitglossary#Documentation/gitglossary.txt-aiddefpathspecapathspec) syntax. If no paths are specified, all new and modified files are added. See [Add specific paths](#add-specific-paths). | |
| `commit-message` | The message to use when committing changes. | `[create-pull-request] automated change` | | `commit-message` | The message to use when committing changes. | `[create-pull-request] automated change` |
| `committer` | The committer name and email address in the format `Display Name <email@address.com>`. Defaults to the GitHub Actions bot user. | `GitHub <noreply@github.com>` | | `committer` | The committer name and email address in the format `Display Name <email@address.com>`. Defaults to the GitHub Actions bot user. | `GitHub <noreply@github.com>` |
| `author` | The author name and email address in the format `Display Name <email@address.com>`. Defaults to the user who triggered the workflow run. | `${{ github.actor }} <${{ github.actor }}@users.noreply.github.com>` | | `author` | The author name and email address in the format `Display Name <email@address.com>`. Defaults to the user who triggered the workflow run. | `${{ github.actor }} <${{ github.actor }}@users.noreply.github.com>` |
@ -68,7 +68,7 @@ All inputs are **optional**. If not set, sensible defaults will be used.
For self-hosted runners behind a corporate proxy set the `https_proxy` environment variable. For self-hosted runners behind a corporate proxy set the `https_proxy` environment variable.
```yml ```yml
- name: Create Pull Request - name: Create Pull Request
uses: peter-evans/create-pull-request@v3 uses: peter-evans/create-pull-request@v4
env: env:
https_proxy: http://<proxy_address>:<port> https_proxy: http://<proxy_address>:<port>
``` ```
@ -88,7 +88,7 @@ Note that in order to read the step outputs the action step must have an id.
```yml ```yml
- name: Create Pull Request - name: Create Pull Request
id: cpr id: cpr
uses: peter-evans/create-pull-request@v3 uses: peter-evans/create-pull-request@v4
- name: Check outputs - name: Check outputs
if: ${{ steps.cpr.outputs.pull-request-number }} if: ${{ steps.cpr.outputs.pull-request-number }}
run: | run: |
@ -147,12 +147,11 @@ If there are files or directories you want to ignore you can simply add them to
You can control which files are committed with the `add-paths` input. You can control which files are committed with the `add-paths` input.
Paths should follow git's [pathspec](https://git-scm.com/docs/gitglossary#Documentation/gitglossary.txt-aiddefpathspecapathspec) syntax. Paths should follow git's [pathspec](https://git-scm.com/docs/gitglossary#Documentation/gitglossary.txt-aiddefpathspecapathspec) syntax.
Each path must resolve to a least one new or modified file to add.
All file changes that do not match one of the paths will be discarded. All file changes that do not match one of the paths will be discarded.
```yml ```yml
- name: Create Pull Request - name: Create Pull Request
uses: peter-evans/create-pull-request@v3 uses: peter-evans/create-pull-request@v4
with: with:
add-paths: | add-paths: |
*.java *.java
@ -166,7 +165,7 @@ Note that the repository must be checked out on a branch with a remote, it won't
```yml ```yml
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v3
- name: Create commits - name: Create commits
run: | run: |
git config user.name 'Peter Evans' git config user.name 'Peter Evans'
@ -179,7 +178,7 @@ Note that the repository must be checked out on a branch with a remote, it won't
- name: Uncommitted change - name: Uncommitted change
run: date +%s > report.txt run: date +%s > report.txt
- name: Create Pull Request - name: Create Pull Request
uses: peter-evans/create-pull-request@v3 uses: peter-evans/create-pull-request@v4
``` ```
### Create a project card ### Create a project card
@ -189,11 +188,11 @@ To create a project card for the pull request, pass the `pull-request-number` st
```yml ```yml
- name: Create Pull Request - name: Create Pull Request
id: cpr id: cpr
uses: peter-evans/create-pull-request@v3 uses: peter-evans/create-pull-request@v4
- name: Create or Update Project Card - name: Create or Update Project Card
if: ${{ steps.cpr.outputs.pull-request-number }} if: ${{ steps.cpr.outputs.pull-request-number }}
uses: peter-evans/create-or-update-project-card@v1 uses: peter-evans/create-or-update-project-card@v2
with: with:
project-name: My project project-name: My project
column-name: My column column-name: My column
@ -217,14 +216,14 @@ jobs:
createPullRequest: createPullRequest:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v3
- name: Make changes to pull request - name: Make changes to pull request
run: date +%s > report.txt run: date +%s > report.txt
- name: Create Pull Request - name: Create Pull Request
id: cpr id: cpr
uses: peter-evans/create-pull-request@v3 uses: peter-evans/create-pull-request@v4
with: with:
token: ${{ secrets.PAT }} token: ${{ secrets.PAT }}
commit-message: Update report commit-message: Update report

186
__test__/create-or-update-branch.int.test.ts
View file

@ -11,8 +11,8 @@ import {v4 as uuidv4} from 'uuid'
const REPO_PATH = '/git/local/test-base' const REPO_PATH = '/git/local/test-base'
const REMOTE_NAME = 'origin' const REMOTE_NAME = 'origin'
const TRACKED_FILE = 'tracked-file.txt' const TRACKED_FILE = 'a/tracked-file.txt'
const UNTRACKED_FILE = 'untracked-file.txt' const UNTRACKED_FILE = 'b/untracked-file.txt'
const DEFAULT_BRANCH = 'tests/master' const DEFAULT_BRANCH = 'tests/master'
const NOT_BASE_BRANCH = 'tests/branch-that-is-not-the-base' const NOT_BASE_BRANCH = 'tests/branch-that-is-not-the-base'
@ -25,12 +25,14 @@ const BASE = DEFAULT_BRANCH
const FORK_REMOTE_URL = 'git://127.0.0.1/test-fork.git' const FORK_REMOTE_URL = 'git://127.0.0.1/test-fork.git'
const FORK_REMOTE_NAME = 'fork' const FORK_REMOTE_NAME = 'fork'
const ADD_PATHS = ['-A'] const ADD_PATHS_DEFAULT = []
const ADD_PATHS_WILDCARD = ['*.txt'] const ADD_PATHS_MULTI = ['a', 'b']
const ADD_PATHS_WILDCARD = ['a/*.txt', 'b/*.txt']
async function createFile(filename: string, content?: string): Promise<string> { async function createFile(filename: string, content?: string): Promise<string> {
const _content = content ? content : uuidv4() const _content = content ? content : uuidv4()
const filepath = path.join(REPO_PATH, filename) const filepath = path.join(REPO_PATH, filename)
await fs.promises.mkdir(path.dirname(filepath), {recursive: true})
await fs.promises.writeFile(filepath, _content, {encoding: 'utf8'}) await fs.promises.writeFile(filepath, _content, {encoding: 'utf8'})
return _content return _content
} }
@ -224,7 +226,7 @@ describe('create-or-update-branch tests', () => {
BRANCH, BRANCH,
REMOTE_NAME, REMOTE_NAME,
false, false,
ADD_PATHS ADD_PATHS_DEFAULT
) )
expect(result.action).toEqual('none') expect(result.action).toEqual('none')
expect(await gitLogMatches([INIT_COMMIT_MESSAGE])).toBeTruthy() expect(await gitLogMatches([INIT_COMMIT_MESSAGE])).toBeTruthy()
@ -241,7 +243,7 @@ describe('create-or-update-branch tests', () => {
BRANCH, BRANCH,
REMOTE_NAME, REMOTE_NAME,
false, false,
ADD_PATHS ADD_PATHS_DEFAULT
) )
expect(result.action).toEqual('created') expect(result.action).toEqual('created')
expect(await getFileContent(TRACKED_FILE)).toEqual(trackedContent) expect(await getFileContent(TRACKED_FILE)).toEqual(trackedContent)
@ -269,7 +271,7 @@ describe('create-or-update-branch tests', () => {
BRANCH, BRANCH,
REMOTE_NAME, REMOTE_NAME,
false, false,
ADD_PATHS ADD_PATHS_DEFAULT
) )
expect(_result.action).toEqual('updated') expect(_result.action).toEqual('updated')
expect(_result.hasDiffWithBase).toBeTruthy() expect(_result.hasDiffWithBase).toBeTruthy()
@ -290,7 +292,7 @@ describe('create-or-update-branch tests', () => {
BRANCH, BRANCH,
REMOTE_NAME, REMOTE_NAME,
false, false,
ADD_PATHS ADD_PATHS_DEFAULT
) )
expect(result.action).toEqual('created') expect(result.action).toEqual('created')
expect(await getFileContent(UNTRACKED_FILE)).toEqual(untrackedContent) expect(await getFileContent(UNTRACKED_FILE)).toEqual(untrackedContent)
@ -318,7 +320,7 @@ describe('create-or-update-branch tests', () => {
BRANCH, BRANCH,
REMOTE_NAME, REMOTE_NAME,
false, false,
ADD_PATHS ADD_PATHS_DEFAULT
) )
expect(_result.action).toEqual('updated') expect(_result.action).toEqual('updated')
expect(_result.hasDiffWithBase).toBeTruthy() expect(_result.hasDiffWithBase).toBeTruthy()
@ -341,7 +343,7 @@ describe('create-or-update-branch tests', () => {
BRANCH, BRANCH,
REMOTE_NAME, REMOTE_NAME,
false, false,
ADD_PATHS ADD_PATHS_DEFAULT
) )
expect(result.action).toEqual('created') expect(result.action).toEqual('created')
expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked) expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked)
@ -370,7 +372,7 @@ describe('create-or-update-branch tests', () => {
BRANCH, BRANCH,
REMOTE_NAME, REMOTE_NAME,
false, false,
ADD_PATHS ADD_PATHS_DEFAULT
) )
expect(_result.action).toEqual('not-updated') expect(_result.action).toEqual('not-updated')
expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked) expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked)
@ -391,7 +393,7 @@ describe('create-or-update-branch tests', () => {
BRANCH, BRANCH,
REMOTE_NAME, REMOTE_NAME,
false, false,
ADD_PATHS ADD_PATHS_DEFAULT
) )
expect(result.action).toEqual('created') expect(result.action).toEqual('created')
expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked) expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked)
@ -428,7 +430,7 @@ describe('create-or-update-branch tests', () => {
BRANCH, BRANCH,
REMOTE_NAME, REMOTE_NAME,
false, false,
ADD_PATHS ADD_PATHS_DEFAULT
) )
expect(_result.action).toEqual('updated') expect(_result.action).toEqual('updated')
expect(_result.hasDiffWithBase).toBeTruthy() expect(_result.hasDiffWithBase).toBeTruthy()
@ -459,7 +461,7 @@ describe('create-or-update-branch tests', () => {
BRANCH, BRANCH,
REMOTE_NAME, REMOTE_NAME,
false, false,
ADD_PATHS ADD_PATHS_DEFAULT
) )
expect(result.action).toEqual('created') expect(result.action).toEqual('created')
expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked) expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked)
@ -487,7 +489,7 @@ describe('create-or-update-branch tests', () => {
BRANCH, BRANCH,
REMOTE_NAME, REMOTE_NAME,
false, false,
ADD_PATHS ADD_PATHS_DEFAULT
) )
expect(_result.action).toEqual('updated') expect(_result.action).toEqual('updated')
expect(_result.hasDiffWithBase).toBeFalsy() expect(_result.hasDiffWithBase).toBeFalsy()
@ -508,7 +510,7 @@ describe('create-or-update-branch tests', () => {
BRANCH, BRANCH,
REMOTE_NAME, REMOTE_NAME,
false, false,
ADD_PATHS ADD_PATHS_DEFAULT
) )
expect(result.action).toEqual('created') expect(result.action).toEqual('created')
expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked) expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked)
@ -548,7 +550,7 @@ describe('create-or-update-branch tests', () => {
BRANCH, BRANCH,
REMOTE_NAME, REMOTE_NAME,
false, false,
ADD_PATHS ADD_PATHS_DEFAULT
) )
expect(_result.action).toEqual('updated') expect(_result.action).toEqual('updated')
expect(_result.hasDiffWithBase).toBeFalsy() expect(_result.hasDiffWithBase).toBeFalsy()
@ -575,7 +577,7 @@ describe('create-or-update-branch tests', () => {
BRANCH, BRANCH,
REMOTE_NAME, REMOTE_NAME,
false, false,
ADD_PATHS ADD_PATHS_DEFAULT
) )
expect(result.action).toEqual('created') expect(result.action).toEqual('created')
expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked) expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked)
@ -618,7 +620,7 @@ describe('create-or-update-branch tests', () => {
BRANCH, BRANCH,
REMOTE_NAME, REMOTE_NAME,
false, false,
ADD_PATHS ADD_PATHS_DEFAULT
) )
expect(_result.action).toEqual('updated') expect(_result.action).toEqual('updated')
expect(_result.hasDiffWithBase).toBeFalsy() expect(_result.hasDiffWithBase).toBeFalsy()
@ -640,7 +642,7 @@ describe('create-or-update-branch tests', () => {
BRANCH, BRANCH,
REMOTE_NAME, REMOTE_NAME,
false, false,
ADD_PATHS ADD_PATHS_DEFAULT
) )
expect(result.action).toEqual('created') expect(result.action).toEqual('created')
expect(await getFileContent(TRACKED_FILE)).toEqual(commits.changes.tracked) expect(await getFileContent(TRACKED_FILE)).toEqual(commits.changes.tracked)
@ -671,7 +673,7 @@ describe('create-or-update-branch tests', () => {
BRANCH, BRANCH,
REMOTE_NAME, REMOTE_NAME,
false, false,
ADD_PATHS ADD_PATHS_DEFAULT
) )
expect(_result.action).toEqual('updated') expect(_result.action).toEqual('updated')
expect(_result.hasDiffWithBase).toBeTruthy() expect(_result.hasDiffWithBase).toBeTruthy()
@ -697,7 +699,7 @@ describe('create-or-update-branch tests', () => {
BRANCH, BRANCH,
REMOTE_NAME, REMOTE_NAME,
false, false,
ADD_PATHS ADD_PATHS_DEFAULT
) )
expect(result.action).toEqual('created') expect(result.action).toEqual('created')
expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked) expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked)
@ -732,7 +734,7 @@ describe('create-or-update-branch tests', () => {
BRANCH, BRANCH,
REMOTE_NAME, REMOTE_NAME,
false, false,
ADD_PATHS ADD_PATHS_DEFAULT
) )
expect(_result.action).toEqual('updated') expect(_result.action).toEqual('updated')
expect(_result.hasDiffWithBase).toBeTruthy() expect(_result.hasDiffWithBase).toBeTruthy()
@ -760,7 +762,7 @@ describe('create-or-update-branch tests', () => {
BRANCH, BRANCH,
REMOTE_NAME, REMOTE_NAME,
false, false,
ADD_PATHS ADD_PATHS_DEFAULT
) )
expect(result.action).toEqual('created') expect(result.action).toEqual('created')
expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked) expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked)
@ -803,7 +805,7 @@ describe('create-or-update-branch tests', () => {
BRANCH, BRANCH,
REMOTE_NAME, REMOTE_NAME,
false, false,
ADD_PATHS ADD_PATHS_DEFAULT
) )
expect(_result.action).toEqual('updated') expect(_result.action).toEqual('updated')
expect(_result.hasDiffWithBase).toBeTruthy() expect(_result.hasDiffWithBase).toBeTruthy()
@ -830,7 +832,7 @@ describe('create-or-update-branch tests', () => {
BRANCH, BRANCH,
FORK_REMOTE_NAME, FORK_REMOTE_NAME,
false, false,
ADD_PATHS ADD_PATHS_DEFAULT
) )
expect(result.action).toEqual('created') expect(result.action).toEqual('created')
expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked) expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked)
@ -859,7 +861,7 @@ describe('create-or-update-branch tests', () => {
BRANCH, BRANCH,
FORK_REMOTE_NAME, FORK_REMOTE_NAME,
false, false,
ADD_PATHS ADD_PATHS_DEFAULT
) )
expect(_result.action).toEqual('updated') expect(_result.action).toEqual('updated')
expect(_result.hasDiffWithBase).toBeTruthy() expect(_result.hasDiffWithBase).toBeTruthy()
@ -881,7 +883,7 @@ describe('create-or-update-branch tests', () => {
BRANCH, BRANCH,
REMOTE_NAME, REMOTE_NAME,
true, true,
ADD_PATHS ADD_PATHS_DEFAULT
) )
expect(result.action).toEqual('created') expect(result.action).toEqual('created')
expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked) expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked)
@ -917,7 +919,7 @@ describe('create-or-update-branch tests', () => {
BRANCH, BRANCH,
REMOTE_NAME, REMOTE_NAME,
true, true,
ADD_PATHS ADD_PATHS_DEFAULT
) )
expect(_result.action).toEqual('updated') expect(_result.action).toEqual('updated')
expect(_result.hasDiffWithBase).toBeTruthy() expect(_result.hasDiffWithBase).toBeTruthy()
@ -935,9 +937,58 @@ describe('create-or-update-branch tests', () => {
) )
}) })
it('tests create and update with wildcard add-paths', async () => { it('tests create and update with multiple add-paths', async () => {
// The pull request branch will not be updated // Create tracked and untracked file changes
const changes = await createChanges()
const commitMessage = uuidv4()
const result = await createOrUpdateBranch(
git,
commitMessage,
'',
BRANCH,
REMOTE_NAME,
false,
ADD_PATHS_MULTI
)
expect(result.action).toEqual('created')
expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked)
expect(await getFileContent(UNTRACKED_FILE)).toEqual(changes.untracked)
expect(
await gitLogMatches([commitMessage, INIT_COMMIT_MESSAGE])
).toBeTruthy()
// Push pull request branch to remote
await git.push([
'--force-with-lease',
REMOTE_NAME,
`HEAD:refs/heads/${BRANCH}`
])
await afterTest(false)
await beforeTest()
// Create tracked and untracked file changes
const _changes = await createChanges()
const _commitMessage = uuidv4()
const _result = await createOrUpdateBranch(
git,
_commitMessage,
'',
BRANCH,
REMOTE_NAME,
false,
ADD_PATHS_MULTI
)
expect(_result.action).toEqual('updated')
expect(_result.hasDiffWithBase).toBeTruthy()
expect(await getFileContent(TRACKED_FILE)).toEqual(_changes.tracked)
expect(await getFileContent(UNTRACKED_FILE)).toEqual(_changes.untracked)
expect(
await gitLogMatches([_commitMessage, INIT_COMMIT_MESSAGE])
).toBeTruthy()
})
it('tests create and update with wildcard add-paths', async () => {
// Create tracked and untracked file changes // Create tracked and untracked file changes
const changes = await createChanges() const changes = await createChanges()
const commitMessage = uuidv4() const commitMessage = uuidv4()
@ -988,6 +1039,23 @@ describe('create-or-update-branch tests', () => {
).toBeTruthy() ).toBeTruthy()
}) })
it('tests create with add-paths resolving to no changes when other changes exist', async () => {
// Create tracked and untracked file changes
await createChanges()
const commitMessage = uuidv4()
const result = await createOrUpdateBranch(
git,
commitMessage,
'',
BRANCH,
REMOTE_NAME,
false,
['nonexistent/*']
)
expect(result.action).toEqual('none')
expect(await gitLogMatches([INIT_COMMIT_MESSAGE])).toBeTruthy()
})
// Working Base is Not Base (WBNB) // Working Base is Not Base (WBNB)
it('tests no changes resulting in no new branch being created (WBNB)', async () => { it('tests no changes resulting in no new branch being created (WBNB)', async () => {
@ -1002,7 +1070,7 @@ describe('create-or-update-branch tests', () => {
BRANCH, BRANCH,
REMOTE_NAME, REMOTE_NAME,
false, false,
ADD_PATHS ADD_PATHS_DEFAULT
) )
expect(result.action).toEqual('none') expect(result.action).toEqual('none')
expect(await gitLogMatches([INIT_COMMIT_MESSAGE])).toBeTruthy() expect(await gitLogMatches([INIT_COMMIT_MESSAGE])).toBeTruthy()
@ -1022,7 +1090,7 @@ describe('create-or-update-branch tests', () => {
BRANCH, BRANCH,
REMOTE_NAME, REMOTE_NAME,
false, false,
ADD_PATHS ADD_PATHS_DEFAULT
) )
expect(result.action).toEqual('created') expect(result.action).toEqual('created')
expect(await getFileContent(TRACKED_FILE)).toEqual(trackedContent) expect(await getFileContent(TRACKED_FILE)).toEqual(trackedContent)
@ -1053,7 +1121,7 @@ describe('create-or-update-branch tests', () => {
BRANCH, BRANCH,
REMOTE_NAME, REMOTE_NAME,
false, false,
ADD_PATHS ADD_PATHS_DEFAULT
) )
expect(_result.action).toEqual('updated') expect(_result.action).toEqual('updated')
expect(_result.hasDiffWithBase).toBeTruthy() expect(_result.hasDiffWithBase).toBeTruthy()
@ -1077,7 +1145,7 @@ describe('create-or-update-branch tests', () => {
BRANCH, BRANCH,
REMOTE_NAME, REMOTE_NAME,
false, false,
ADD_PATHS ADD_PATHS_DEFAULT
) )
expect(result.action).toEqual('created') expect(result.action).toEqual('created')
expect(await getFileContent(UNTRACKED_FILE)).toEqual(untrackedContent) expect(await getFileContent(UNTRACKED_FILE)).toEqual(untrackedContent)
@ -1108,7 +1176,7 @@ describe('create-or-update-branch tests', () => {
BRANCH, BRANCH,
REMOTE_NAME, REMOTE_NAME,
false, false,
ADD_PATHS ADD_PATHS_DEFAULT
) )
expect(_result.action).toEqual('updated') expect(_result.action).toEqual('updated')
expect(_result.hasDiffWithBase).toBeTruthy() expect(_result.hasDiffWithBase).toBeTruthy()
@ -1134,7 +1202,7 @@ describe('create-or-update-branch tests', () => {
BRANCH, BRANCH,
REMOTE_NAME, REMOTE_NAME,
false, false,
ADD_PATHS ADD_PATHS_DEFAULT
) )
expect(result.action).toEqual('created') expect(result.action).toEqual('created')
expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked) expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked)
@ -1166,7 +1234,7 @@ describe('create-or-update-branch tests', () => {
BRANCH, BRANCH,
REMOTE_NAME, REMOTE_NAME,
false, false,
ADD_PATHS ADD_PATHS_DEFAULT
) )
expect(_result.action).toEqual('not-updated') expect(_result.action).toEqual('not-updated')
expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked) expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked)
@ -1190,7 +1258,7 @@ describe('create-or-update-branch tests', () => {
BRANCH, BRANCH,
REMOTE_NAME, REMOTE_NAME,
false, false,
ADD_PATHS ADD_PATHS_DEFAULT
) )
expect(result.action).toEqual('created') expect(result.action).toEqual('created')
expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked) expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked)
@ -1230,7 +1298,7 @@ describe('create-or-update-branch tests', () => {
BRANCH, BRANCH,
REMOTE_NAME, REMOTE_NAME,
false, false,
ADD_PATHS ADD_PATHS_DEFAULT
) )
expect(_result.action).toEqual('updated') expect(_result.action).toEqual('updated')
expect(_result.hasDiffWithBase).toBeTruthy() expect(_result.hasDiffWithBase).toBeTruthy()
@ -1264,7 +1332,7 @@ describe('create-or-update-branch tests', () => {
BRANCH, BRANCH,
REMOTE_NAME, REMOTE_NAME,
false, false,
ADD_PATHS ADD_PATHS_DEFAULT
) )
expect(result.action).toEqual('created') expect(result.action).toEqual('created')
expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked) expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked)
@ -1295,7 +1363,7 @@ describe('create-or-update-branch tests', () => {
BRANCH, BRANCH,
REMOTE_NAME, REMOTE_NAME,
false, false,
ADD_PATHS ADD_PATHS_DEFAULT
) )
expect(_result.action).toEqual('updated') expect(_result.action).toEqual('updated')
expect(_result.hasDiffWithBase).toBeFalsy() expect(_result.hasDiffWithBase).toBeFalsy()
@ -1321,7 +1389,7 @@ describe('create-or-update-branch tests', () => {
BRANCH, BRANCH,
REMOTE_NAME, REMOTE_NAME,
false, false,
ADD_PATHS ADD_PATHS_DEFAULT
) )
expect(result.action).toEqual('created') expect(result.action).toEqual('created')
expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked) expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked)
@ -1364,7 +1432,7 @@ describe('create-or-update-branch tests', () => {
BRANCH, BRANCH,
REMOTE_NAME, REMOTE_NAME,
false, false,
ADD_PATHS ADD_PATHS_DEFAULT
) )
expect(_result.action).toEqual('updated') expect(_result.action).toEqual('updated')
expect(_result.hasDiffWithBase).toBeFalsy() expect(_result.hasDiffWithBase).toBeFalsy()
@ -1394,7 +1462,7 @@ describe('create-or-update-branch tests', () => {
BRANCH, BRANCH,
REMOTE_NAME, REMOTE_NAME,
false, false,
ADD_PATHS ADD_PATHS_DEFAULT
) )
expect(result.action).toEqual('created') expect(result.action).toEqual('created')
expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked) expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked)
@ -1440,7 +1508,7 @@ describe('create-or-update-branch tests', () => {
BRANCH, BRANCH,
REMOTE_NAME, REMOTE_NAME,
false, false,
ADD_PATHS ADD_PATHS_DEFAULT
) )
expect(_result.action).toEqual('updated') expect(_result.action).toEqual('updated')
expect(_result.hasDiffWithBase).toBeFalsy() expect(_result.hasDiffWithBase).toBeFalsy()
@ -1465,7 +1533,7 @@ describe('create-or-update-branch tests', () => {
BRANCH, BRANCH,
REMOTE_NAME, REMOTE_NAME,
false, false,
ADD_PATHS ADD_PATHS_DEFAULT
) )
expect(result.action).toEqual('created') expect(result.action).toEqual('created')
expect(await getFileContent(TRACKED_FILE)).toEqual(commits.changes.tracked) expect(await getFileContent(TRACKED_FILE)).toEqual(commits.changes.tracked)
@ -1499,7 +1567,7 @@ describe('create-or-update-branch tests', () => {
BRANCH, BRANCH,
REMOTE_NAME, REMOTE_NAME,
false, false,
ADD_PATHS ADD_PATHS_DEFAULT
) )
expect(_result.action).toEqual('updated') expect(_result.action).toEqual('updated')
expect(_result.hasDiffWithBase).toBeTruthy() expect(_result.hasDiffWithBase).toBeTruthy()
@ -1528,7 +1596,7 @@ describe('create-or-update-branch tests', () => {
BRANCH, BRANCH,
REMOTE_NAME, REMOTE_NAME,
false, false,
ADD_PATHS ADD_PATHS_DEFAULT
) )
expect(result.action).toEqual('created') expect(result.action).toEqual('created')
expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked) expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked)
@ -1566,7 +1634,7 @@ describe('create-or-update-branch tests', () => {
BRANCH, BRANCH,
REMOTE_NAME, REMOTE_NAME,
false, false,
ADD_PATHS ADD_PATHS_DEFAULT
) )
expect(_result.action).toEqual('updated') expect(_result.action).toEqual('updated')
expect(_result.hasDiffWithBase).toBeTruthy() expect(_result.hasDiffWithBase).toBeTruthy()
@ -1597,7 +1665,7 @@ describe('create-or-update-branch tests', () => {
BRANCH, BRANCH,
REMOTE_NAME, REMOTE_NAME,
false, false,
ADD_PATHS ADD_PATHS_DEFAULT
) )
expect(result.action).toEqual('created') expect(result.action).toEqual('created')
expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked) expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked)
@ -1643,7 +1711,7 @@ describe('create-or-update-branch tests', () => {
BRANCH, BRANCH,
REMOTE_NAME, REMOTE_NAME,
false, false,
ADD_PATHS ADD_PATHS_DEFAULT
) )
expect(_result.action).toEqual('updated') expect(_result.action).toEqual('updated')
expect(_result.hasDiffWithBase).toBeTruthy() expect(_result.hasDiffWithBase).toBeTruthy()
@ -1673,7 +1741,7 @@ describe('create-or-update-branch tests', () => {
BRANCH, BRANCH,
FORK_REMOTE_NAME, FORK_REMOTE_NAME,
false, false,
ADD_PATHS ADD_PATHS_DEFAULT
) )
expect(result.action).toEqual('created') expect(result.action).toEqual('created')
expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked) expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked)
@ -1705,7 +1773,7 @@ describe('create-or-update-branch tests', () => {
BRANCH, BRANCH,
FORK_REMOTE_NAME, FORK_REMOTE_NAME,
false, false,
ADD_PATHS ADD_PATHS_DEFAULT
) )
expect(_result.action).toEqual('updated') expect(_result.action).toEqual('updated')
expect(_result.hasDiffWithBase).toBeTruthy() expect(_result.hasDiffWithBase).toBeTruthy()
@ -1734,7 +1802,7 @@ describe('create-or-update-branch tests', () => {
BRANCH, BRANCH,
REMOTE_NAME, REMOTE_NAME,
false, false,
ADD_PATHS ADD_PATHS_DEFAULT
) )
expect(result.action).toEqual('created') expect(result.action).toEqual('created')
expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked) expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked)
@ -1767,7 +1835,7 @@ describe('create-or-update-branch tests', () => {
BRANCH, BRANCH,
REMOTE_NAME, REMOTE_NAME,
false, false,
ADD_PATHS ADD_PATHS_DEFAULT
) )
expect(_result.action).toEqual('updated') expect(_result.action).toEqual('updated')
expect(_result.hasDiffWithBase).toBeTruthy() expect(_result.hasDiffWithBase).toBeTruthy()
@ -1793,7 +1861,7 @@ describe('create-or-update-branch tests', () => {
BRANCH, BRANCH,
REMOTE_NAME, REMOTE_NAME,
false, false,
ADD_PATHS ADD_PATHS_DEFAULT
) )
expect(result.action).toEqual('created') expect(result.action).toEqual('created')
expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked) expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked)
@ -1834,7 +1902,7 @@ describe('create-or-update-branch tests', () => {
BRANCH, BRANCH,
REMOTE_NAME, REMOTE_NAME,
false, false,
ADD_PATHS ADD_PATHS_DEFAULT
) )
expect(_result.action).toEqual('updated') expect(_result.action).toEqual('updated')
expect(_result.hasDiffWithBase).toBeTruthy() expect(_result.hasDiffWithBase).toBeTruthy()
@ -1866,7 +1934,7 @@ describe('create-or-update-branch tests', () => {
BRANCH, BRANCH,
REMOTE_NAME, REMOTE_NAME,
false, false,
ADD_PATHS ADD_PATHS_DEFAULT
) )
// The action cannot successfully create the branch // The action cannot successfully create the branch
expect(result.action).toEqual('none') expect(result.action).toEqual('none')

4
action.yml
View file

@ -13,8 +13,6 @@ inputs:
A comma or newline-separated list of file paths to commit. A comma or newline-separated list of file paths to commit.
Paths should follow git's pathspec syntax. Paths should follow git's pathspec syntax.
Defaults to adding all new and modified files. Defaults to adding all new and modified files.
default: |
-A
commit-message: commit-message:
description: 'The message to use when committing changes.' description: 'The message to use when committing changes.'
default: '[create-pull-request] automated change' default: '[create-pull-request] automated change'
@ -81,7 +79,7 @@ outputs:
pull-request-head-sha: pull-request-head-sha:
description: 'The commit SHA of the pull request branch.' description: 'The commit SHA of the pull request branch.'
runs: runs:
using: 'node12' using: 'node16'
main: 'dist/index.js' main: 'dist/index.js'
branding: branding:
icon: 'git-pull-request' icon: 'git-pull-request'

40
dist/index.js vendored
View file

@ -122,20 +122,25 @@ function createOrUpdateBranch(git, commitMessage, base, branch, branchRemoteName
const tempBranch = (0, uuid_1.v4)(); const tempBranch = (0, uuid_1.v4)();
yield git.checkout(tempBranch, 'HEAD'); yield git.checkout(tempBranch, 'HEAD');
// Commit any uncommitted changes // Commit any uncommitted changes
if (yield git.isDirty(true)) { if (yield git.isDirty(true, addPaths)) {
core.info('Uncommitted changes found. Adding a commit.'); core.info('Uncommitted changes found. Adding a commit.');
for (const path of addPaths) { const aopts = ['add'];
yield git.exec(['add', path], true); if (addPaths.length > 0) {
aopts.push(...['--', ...addPaths]);
} }
const params = ['-m', commitMessage]; else {
aopts.push('-A');
}
yield git.exec(aopts, true);
const popts = ['-m', commitMessage];
if (signoff) { if (signoff) {
params.push('--signoff'); popts.push('--signoff');
}
yield git.commit(popts);
} }
yield git.commit(params);
// Remove uncommitted tracked and untracked changes // Remove uncommitted tracked and untracked changes
yield git.exec(['reset', '--hard']); yield git.exec(['reset', '--hard']);
yield git.exec(['clean', '-f']); yield git.exec(['clean', '-f', '-d']);
}
// Perform fetch and reset the working base // Perform fetch and reset the working base
// Commits made during the workflow will be removed // Commits made during the workflow will be removed
if (workingBaseType == WorkingBaseType.Branch) { if (workingBaseType == WorkingBaseType.Branch) {
@ -752,18 +757,23 @@ class GitCommandManager {
return output.exitCode === 1; return output.exitCode === 1;
}); });
} }
isDirty(untracked) { isDirty(untracked, pathspec) {
return __awaiter(this, void 0, void 0, function* () { return __awaiter(this, void 0, void 0, function* () {
const pathspecArgs = pathspec ? ['--', ...pathspec] : [];
// Check untracked changes // Check untracked changes
if (untracked && (yield this.status(['--porcelain', '-unormal']))) { const sargs = ['--porcelain', '-unormal'];
sargs.push(...pathspecArgs);
if (untracked && (yield this.status(sargs))) {
return true; return true;
} }
// Check working index changes // Check working index changes
if (yield this.hasDiff()) { if (yield this.hasDiff(pathspecArgs)) {
return true; return true;
} }
// Check staged changes // Check staged changes
if (yield this.hasDiff(['--staged'])) { const dargs = ['--staged'];
dargs.push(...pathspecArgs);
if (yield this.hasDiff(dargs)) {
return true; return true;
} }
return false; return false;
@ -1085,9 +1095,9 @@ function run() {
commitMessage: core.getInput('commit-message'), commitMessage: core.getInput('commit-message'),
committer: core.getInput('committer'), committer: core.getInput('committer'),
author: core.getInput('author'), author: core.getInput('author'),
signoff: core.getInput('signoff') === 'true', signoff: core.getBooleanInput('signoff'),
branch: core.getInput('branch'), branch: core.getInput('branch'),
deleteBranch: core.getInput('delete-branch') === 'true', deleteBranch: core.getBooleanInput('delete-branch'),
branchSuffix: core.getInput('branch-suffix'), branchSuffix: core.getInput('branch-suffix'),
base: core.getInput('base'), base: core.getInput('base'),
pushToFork: core.getInput('push-to-fork'), pushToFork: core.getInput('push-to-fork'),
@ -1098,7 +1108,7 @@ function run() {
reviewers: utils.getInputAsArray('reviewers'), reviewers: utils.getInputAsArray('reviewers'),
teamReviewers: utils.getInputAsArray('team-reviewers'), teamReviewers: utils.getInputAsArray('team-reviewers'),
milestone: Number(core.getInput('milestone')), milestone: Number(core.getInput('milestone')),
draft: core.getInput('draft') === 'true' draft: core.getBooleanInput('draft')
}; };
core.debug(`Inputs: ${(0, util_1.inspect)(inputs)}`); core.debug(`Inputs: ${(0, util_1.inspect)(inputs)}`);
yield (0, create_pull_request_1.createPullRequest)(inputs); yield (0, create_pull_request_1.createPullRequest)(inputs);

36
docs/concepts-guidelines.md
View file

@ -36,7 +36,7 @@ For each [event type](https://docs.github.com/en/actions/reference/events-that-t
The default can be overridden by specifying a `ref` on checkout. The default can be overridden by specifying a `ref` on checkout.
```yml ```yml
- uses: actions/checkout@v2 - uses: actions/checkout@v3
with: with:
ref: develop ref: develop
``` ```
@ -73,7 +73,7 @@ jobs:
example: example:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v3
``` ```
There may be use cases where it makes sense to execute the workflow on a branch that is not the base of the pull request. In these cases, the base branch can be specified with the `base` action input. The action will attempt to rebase changes made during the workflow on to the actual base. There may be use cases where it makes sense to execute the workflow on a branch that is not the base of the pull request. In these cases, the base branch can be specified with the `base` action input. The action will attempt to rebase changes made during the workflow on to the actual base.
@ -88,7 +88,7 @@ In these cases, you *must supply* the `base` input so the action can rebase chan
Workflows triggered by [`pull_request`](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#pull_request) events will by default check out a merge commit. Set the `base` input as follows to base the new pull request on the current pull request's branch. Workflows triggered by [`pull_request`](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#pull_request) events will by default check out a merge commit. Set the `base` input as follows to base the new pull request on the current pull request's branch.
```yml ```yml
- uses: peter-evans/create-pull-request@v3 - uses: peter-evans/create-pull-request@v4
with: with:
base: ${{ github.head_ref }} base: ${{ github.head_ref }}
``` ```
@ -96,7 +96,7 @@ Workflows triggered by [`pull_request`](https://docs.github.com/en/actions/refer
Workflows triggered by [`release`](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#release) events will by default check out a tag. For most use cases, you will need to set the `base` input to the branch name of the tagged commit. Workflows triggered by [`release`](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#release) events will by default check out a tag. For most use cases, you will need to set the `base` input to the branch name of the tagged commit.
```yml ```yml
- uses: peter-evans/create-pull-request@v3 - uses: peter-evans/create-pull-request@v4
with: with:
base: main base: main
``` ```
@ -173,14 +173,14 @@ This action uses [ncc](https://github.com/vercel/ncc) to compile the Node.js cod
Checking out a branch from a different repository from where the workflow is executing will make *that repository* the target for the created pull request. In this case, a `repo` scoped [Personal Access Token (PAT)](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) is required. Checking out a branch from a different repository from where the workflow is executing will make *that repository* the target for the created pull request. In this case, a `repo` scoped [Personal Access Token (PAT)](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) is required.
```yml ```yml
- uses: actions/checkout@v2 - uses: actions/checkout@v3
with: with:
token: ${{ secrets.PAT }} token: ${{ secrets.PAT }}
repository: owner/repo repository: owner/repo
# Make changes to pull request here # Make changes to pull request here
- uses: peter-evans/create-pull-request@v3 - uses: peter-evans/create-pull-request@v4
with: with:
token: ${{ secrets.PAT }} token: ${{ secrets.PAT }}
``` ```
@ -200,14 +200,14 @@ How to use SSH (deploy keys) with create-pull-request action:
```yml ```yml
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v3
with: with:
ssh-key: ${{ secrets.SSH_PRIVATE_KEY }} ssh-key: ${{ secrets.SSH_PRIVATE_KEY }}
# Make changes to pull request here # Make changes to pull request here
- name: Create Pull Request - name: Create Pull Request
uses: peter-evans/create-pull-request@v3 uses: peter-evans/create-pull-request@v4
``` ```
### Push pull request branches to a fork ### Push pull request branches to a fork
@ -225,11 +225,11 @@ It will use their own fork to push code and create the pull request.
6. As shown in the following example workflow, set the `push-to-fork` input to the full repository name of the fork. 6. As shown in the following example workflow, set the `push-to-fork` input to the full repository name of the fork.
```yaml ```yaml
- uses: actions/checkout@v2 - uses: actions/checkout@v3
# Make changes to pull request here # Make changes to pull request here
- uses: peter-evans/create-pull-request@v3 - uses: peter-evans/create-pull-request@v4
with: with:
token: ${{ secrets.MACHINE_USER_PAT }} token: ${{ secrets.MACHINE_USER_PAT }}
push-to-fork: machine-user/fork-of-repository push-to-fork: machine-user/fork-of-repository
@ -261,7 +261,7 @@ GitHub App generated tokens are more secure than using a PAT because GitHub App
```yaml ```yaml
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v3
- uses: tibdex/github-app-token@v1 - uses: tibdex/github-app-token@v1
id: generate-token id: generate-token
@ -272,7 +272,7 @@ GitHub App generated tokens are more secure than using a PAT because GitHub App
# Make changes to pull request here # Make changes to pull request here
- name: Create Pull Request - name: Create Pull Request
uses: peter-evans/create-pull-request@v3 uses: peter-evans/create-pull-request@v4
with: with:
token: ${{ steps.generate-token.outputs.token }} token: ${{ steps.generate-token.outputs.token }}
``` ```
@ -301,7 +301,7 @@ The action can use GPG to sign commits with a GPG key that you generate yourself
```yaml ```yaml
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v3
- uses: crazy-max/ghaction-import-gpg@v3 - uses: crazy-max/ghaction-import-gpg@v3
with: with:
@ -313,7 +313,7 @@ The action can use GPG to sign commits with a GPG key that you generate yourself
# Make changes to pull request here # Make changes to pull request here
- name: Create Pull Request - name: Create Pull Request
uses: peter-evans/create-pull-request@v3 uses: peter-evans/create-pull-request@v4
with: with:
token: ${{ secrets.PAT }} token: ${{ secrets.PAT }}
committer: example <email@example.com> committer: example <email@example.com>
@ -338,12 +338,12 @@ jobs:
- name: Install dependencies - name: Install dependencies
run: apk --no-cache add git run: apk --no-cache add git
- uses: actions/checkout@v2 - uses: actions/checkout@v3
# Make changes to pull request here # Make changes to pull request here
- name: Create Pull Request - name: Create Pull Request
uses: peter-evans/create-pull-request@v3 uses: peter-evans/create-pull-request@v4
``` ```
**Ubuntu container example:** **Ubuntu container example:**
@ -361,10 +361,10 @@ jobs:
add-apt-repository -y ppa:git-core/ppa add-apt-repository -y ppa:git-core/ppa
apt-get install -y git apt-get install -y git
- uses: actions/checkout@v2 - uses: actions/checkout@v3
# Make changes to pull request here # Make changes to pull request here
- name: Create Pull Request - name: Create Pull Request
uses: peter-evans/create-pull-request@v3 uses: peter-evans/create-pull-request@v4
``` ```

67
docs/examples.md
View file

@ -43,14 +43,14 @@ jobs:
updateAuthors: updateAuthors:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v3
with: with:
fetch-depth: 0 fetch-depth: 0
- name: Update AUTHORS - name: Update AUTHORS
run: | run: |
git log --format='%aN <%aE>%n%cN <%cE>' | sort -u > AUTHORS git log --format='%aN <%aE>%n%cN <%cE>' | sort -u > AUTHORS
- name: Create Pull Request - name: Create Pull Request
uses: peter-evans/create-pull-request@v3 uses: peter-evans/create-pull-request@v4
with: with:
commit-message: update authors commit-message: update authors
title: Update AUTHORS title: Update AUTHORS
@ -74,7 +74,7 @@ jobs:
productionPromotion: productionPromotion:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v3
with: with:
ref: production ref: production
- name: Reset promotion branch - name: Reset promotion branch
@ -82,7 +82,7 @@ jobs:
git fetch origin main:main git fetch origin main:main
git reset --hard main git reset --hard main
- name: Create Pull Request - name: Create Pull Request
uses: peter-evans/create-pull-request@v3 uses: peter-evans/create-pull-request@v4
with: with:
branch: production-promotion branch: production-promotion
``` ```
@ -107,7 +107,7 @@ jobs:
updateChangelog: updateChangelog:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v3
with: with:
fetch-depth: 0 fetch-depth: 0
- name: Update Changelog - name: Update Changelog
@ -117,7 +117,7 @@ jobs:
./git-chglog -o CHANGELOG.md ./git-chglog -o CHANGELOG.md
rm git-chglog rm git-chglog
- name: Create Pull Request - name: Create Pull Request
uses: peter-evans/create-pull-request@v3 uses: peter-evans/create-pull-request@v4
with: with:
commit-message: update changelog commit-message: update changelog
title: Update Changelog title: Update Changelog
@ -145,16 +145,16 @@ jobs:
update-dep: update-dep:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v3
- uses: actions/setup-node@v1 - uses: actions/setup-node@v3
with: with:
node-version: '12.x' node-version: '16.x'
- name: Update dependencies - name: Update dependencies
run: | run: |
npx -p npm-check-updates ncu -u npx -p npm-check-updates ncu -u
npm install npm install
- name: Create Pull Request - name: Create Pull Request
uses: peter-evans/create-pull-request@v3 uses: peter-evans/create-pull-request@v4
with: with:
token: ${{ secrets.PAT }} token: ${{ secrets.PAT }}
commit-message: Update dependencies commit-message: Update dependencies
@ -181,10 +181,10 @@ jobs:
build: build:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v3
- uses: actions/setup-node@v1 - uses: actions/setup-node@v3
with: with:
node-version: 12.x node-version: 16.x
- run: npm ci - run: npm ci
- run: npm run test - run: npm run test
- run: npm run build - run: npm run build
@ -205,16 +205,17 @@ jobs:
update-dep: update-dep:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v3
- uses: actions/setup-java@v1 - uses: actions/setup-java@v2
with: with:
distribution: 'temurin'
java-version: 1.8 java-version: 1.8
- name: Grant execute permission for gradlew - name: Grant execute permission for gradlew
run: chmod +x gradlew run: chmod +x gradlew
- name: Perform dependency resolution and write new lockfiles - name: Perform dependency resolution and write new lockfiles
run: ./gradlew dependencies --write-locks run: ./gradlew dependencies --write-locks
- name: Create Pull Request - name: Create Pull Request
uses: peter-evans/create-pull-request@v3 uses: peter-evans/create-pull-request@v4
with: with:
token: ${{ secrets.PAT }} token: ${{ secrets.PAT }}
commit-message: Update dependencies commit-message: Update dependencies
@ -242,14 +243,14 @@ jobs:
update-dep: update-dep:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v3
- name: Update dependencies - name: Update dependencies
run: | run: |
cargo install cargo-edit cargo install cargo-edit
cargo update cargo update
cargo upgrade --to-lockfile cargo upgrade --to-lockfile
- name: Create Pull Request - name: Create Pull Request
uses: peter-evans/create-pull-request@v3 uses: peter-evans/create-pull-request@v4
with: with:
token: ${{ secrets.PAT }} token: ${{ secrets.PAT }}
commit-message: Update dependencies commit-message: Update dependencies
@ -277,7 +278,7 @@ jobs:
updateSwagger: updateSwagger:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v3
- name: Get Latest Swagger UI Release - name: Get Latest Swagger UI Release
id: swagger-ui id: swagger-ui
run: | run: |
@ -305,7 +306,7 @@ jobs:
# Update current release # Update current release
echo ${{ steps.swagger-ui.outputs.release_tag }} > swagger-ui.version echo ${{ steps.swagger-ui.outputs.release_tag }} > swagger-ui.version
- name: Create Pull Request - name: Create Pull Request
uses: peter-evans/create-pull-request@v3 uses: peter-evans/create-pull-request@v4
with: with:
commit-message: Update swagger-ui to ${{ steps.swagger-ui.outputs.release_tag }} commit-message: Update swagger-ui to ${{ steps.swagger-ui.outputs.release_tag }}
title: Update SwaggerUI to ${{ steps.swagger-ui.outputs.release_tag }} title: Update SwaggerUI to ${{ steps.swagger-ui.outputs.release_tag }}
@ -340,7 +341,7 @@ jobs:
updateFork: updateFork:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v3
with: with:
repository: fork-owner/repo repository: fork-owner/repo
- name: Reset the default branch with upstream changes - name: Reset the default branch with upstream changes
@ -349,7 +350,7 @@ jobs:
git fetch upstream main:upstream-main git fetch upstream main:upstream-main
git reset --hard upstream-main git reset --hard upstream-main
- name: Create Pull Request - name: Create Pull Request
uses: peter-evans/create-pull-request@v3 uses: peter-evans/create-pull-request@v4
with: with:
token: ${{ secrets.PAT }} token: ${{ secrets.PAT }}
branch: upstream-changes branch: upstream-changes
@ -368,7 +369,7 @@ jobs:
format: format:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v3
- name: Download website - name: Download website
run: | run: |
wget \ wget \
@ -382,7 +383,7 @@ jobs:
--domains quotes.toscrape.com \ --domains quotes.toscrape.com \
http://quotes.toscrape.com/ http://quotes.toscrape.com/
- name: Create Pull Request - name: Create Pull Request
uses: peter-evans/create-pull-request@v3 uses: peter-evans/create-pull-request@v4
with: with:
commit-message: update local website copy commit-message: update local website copy
title: Automated Updates to Local Website Copy title: Automated Updates to Local Website Copy
@ -427,7 +428,7 @@ An `on: repository_dispatch` workflow can be triggered from another workflow wit
```yml ```yml
- name: Repository Dispatch - name: Repository Dispatch
uses: peter-evans/repository-dispatch@v1 uses: peter-evans/repository-dispatch@v2
with: with:
token: ${{ secrets.REPO_ACCESS_TOKEN }} token: ${{ secrets.REPO_ACCESS_TOKEN }}
repository: username/my-repo repository: username/my-repo
@ -464,7 +465,7 @@ jobs:
if: startsWith(github.head_ref, 'autopep8-patches') == false && github.event.pull_request.head.repo.full_name == github.repository if: startsWith(github.head_ref, 'autopep8-patches') == false && github.event.pull_request.head.repo.full_name == github.repository
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v3
with: with:
ref: ${{ github.head_ref }} ref: ${{ github.head_ref }}
- name: autopep8 - name: autopep8
@ -477,7 +478,7 @@ jobs:
run: echo ::set-output name=branch-name::"autopep8-patches/${{ github.head_ref }}" run: echo ::set-output name=branch-name::"autopep8-patches/${{ github.head_ref }}"
- name: Create Pull Request - name: Create Pull Request
if: steps.autopep8.outputs.exit-code == 2 if: steps.autopep8.outputs.exit-code == 2
uses: peter-evans/create-pull-request@v3 uses: peter-evans/create-pull-request@v4
with: with:
commit-message: autopep8 action fixes commit-message: autopep8 action fixes
title: Fixes by autopep8 action title: Fixes by autopep8 action
@ -511,13 +512,13 @@ jobs:
if: startsWith(github.ref, 'refs/heads/') if: startsWith(github.ref, 'refs/heads/')
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v3
... ...
someOtherJob: someOtherJob:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v3
... ...
``` ```
@ -535,7 +536,7 @@ The recommended method is to use [`set-output`](https://docs.github.com/en/actio
echo ::set-output name=pr_body::"This PR was auto-generated on $(date +%d-%m-%Y) \ echo ::set-output name=pr_body::"This PR was auto-generated on $(date +%d-%m-%Y) \
by [create-pull-request](https://github.com/peter-evans/create-pull-request)." by [create-pull-request](https://github.com/peter-evans/create-pull-request)."
- name: Create Pull Request - name: Create Pull Request
uses: peter-evans/create-pull-request@v3 uses: peter-evans/create-pull-request@v4
with: with:
title: ${{ steps.vars.outputs.pr_title }} title: ${{ steps.vars.outputs.pr_title }}
body: ${{ steps.vars.outputs.pr_body }} body: ${{ steps.vars.outputs.pr_body }}
@ -556,7 +557,7 @@ The content must be [escaped to preserve newlines](https://github.community/t/se
echo ::set-output name=body::$body echo ::set-output name=body::$body
- name: Create Pull Request - name: Create Pull Request
uses: peter-evans/create-pull-request@v3 uses: peter-evans/create-pull-request@v4
with: with:
body: ${{ steps.get-pr-body.outputs.body }} body: ${{ steps.get-pr-body.outputs.body }}
``` ```
@ -573,7 +574,7 @@ The template is rendered using the [render-template](https://github.com/chuhlomi
```yml ```yml
- name: Render template - name: Render template
id: template id: template
uses: chuhlomin/render-template@v1.2 uses: chuhlomin/render-template@v1.4
with: with:
template: .github/pull-request-template.md template: .github/pull-request-template.md
vars: | vars: |
@ -581,7 +582,7 @@ The template is rendered using the [render-template](https://github.com/chuhlomi
bar: that bar: that
- name: Create Pull Request - name: Create Pull Request
uses: peter-evans/create-pull-request@v3 uses: peter-evans/create-pull-request@v4
with: with:
body: ${{ steps.template.outputs.result }} body: ${{ steps.template.outputs.result }}
``` ```

18
docs/updating.md
View file

@ -1,3 +1,17 @@
## Updating from `v3` to `v4`
### Breaking changes
- The `add-paths` input no longer accepts `-A` as a valid value. When committing all new and modified files the `add-paths` input should be omitted.
- If using self-hosted runners or GitHub Enterprise Server, there are minimum requirements for `v4` to run. See "What's new" below for details.
### What's new
- Updated runtime to Node.js 16
- The action now requires a minimum version of v2.285.0 for the [Actions Runner](https://github.com/actions/runner/releases/tag/v2.285.0).
- If using GitHub Enterprise Server, the action requires [GHES 3.4](https://docs.github.com/en/enterprise-server@3.4/admin/release-notes) or later.
## Updating from `v2` to `v3` ## Updating from `v2` to `v3`
### Breaking changes ### Breaking changes
@ -31,7 +45,7 @@
push-to-fork: machine-user/fork-of-repository push-to-fork: machine-user/fork-of-repository
``` ```
### New features ### What's new
- The action has been converted to Typescript giving it a significant performance improvement. - The action has been converted to Typescript giving it a significant performance improvement.
@ -66,7 +80,7 @@
If neither `author` or `committer` are set the action will default to making commits as the GitHub Actions bot user. If neither `author` or `committer` are set the action will default to making commits as the GitHub Actions bot user.
### New features ### What's new
- Unpushed commits made during the workflow before the action runs will now be considered as changes to be raised in the pull request. See [Create your own commits](https://github.com/peter-evans/create-pull-request#create-your-own-commits) for details. - Unpushed commits made during the workflow before the action runs will now be considered as changes to be raised in the pull request. See [Create your own commits](https://github.com/peter-evans/create-pull-request#create-your-own-commits) for details.
- New commits made to the pull request base will now be taken into account when pull requests are updated. - New commits made to the pull request base will now be taken into account when pull requests are updated.

16
package-lock.json generated
View file

@ -1,12 +1,12 @@
{ {
"name": "create-pull-request", "name": "create-pull-request",
"version": "3.0.0", "version": "4.0.0",
"lockfileVersion": 2, "lockfileVersion": 2,
"requires": true, "requires": true,
"packages": { "packages": {
"": { "": {
"name": "create-pull-request", "name": "create-pull-request",
"version": "3.0.0", "version": "4.0.0",
"license": "MIT", "license": "MIT",
"dependencies": { "dependencies": {
"@actions/core": "^1.6.0", "@actions/core": "^1.6.0",
@ -4928,9 +4928,9 @@
} }
}, },
"node_modules/minimist": { "node_modules/minimist": {
"version": "1.2.5", "version": "1.2.6",
"resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.5.tgz", "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.6.tgz",
"integrity": "sha512-FM9nNUYrRBAELZQT3xeZQ7fmMOBg6nWNmJKTcgsJeaLstP/UODVpGsr5OhXhhXg6f+qtJ8uiZ+PUxkDWcgIXLw==", "integrity": "sha512-Jsjnk4bw3YJqYzbdyBiNsPWHPfO++UGG749Cxs6peCu5Xg4nrena6OVxOYxrQTqww0Jmwt+Ref8rggumkTLz9Q==",
"dev": true "dev": true
}, },
"node_modules/ms": { "node_modules/ms": {
@ -10068,9 +10068,9 @@
} }
}, },
"minimist": { "minimist": {
"version": "1.2.5", "version": "1.2.6",
"resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.5.tgz", "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.6.tgz",
"integrity": "sha512-FM9nNUYrRBAELZQT3xeZQ7fmMOBg6nWNmJKTcgsJeaLstP/UODVpGsr5OhXhhXg6f+qtJ8uiZ+PUxkDWcgIXLw==", "integrity": "sha512-Jsjnk4bw3YJqYzbdyBiNsPWHPfO++UGG749Cxs6peCu5Xg4nrena6OVxOYxrQTqww0Jmwt+Ref8rggumkTLz9Q==",
"dev": true "dev": true
}, },
"ms": { "ms": {

2
package.json
View file

@ -1,6 +1,6 @@
{ {
"name": "create-pull-request", "name": "create-pull-request",
"version": "3.0.0", "version": "4.0.0",
"private": true, "private": true,
"description": "Creates a pull request for changes to your repository in the actions workspace", "description": "Creates a pull request for changes to your repository in the actions workspace",
"main": "lib/main.js", "main": "lib/main.js",

21
src/create-or-update-branch.ts
View file

@ -119,20 +119,25 @@ export async function createOrUpdateBranch(
const tempBranch = uuidv4() const tempBranch = uuidv4()
await git.checkout(tempBranch, 'HEAD') await git.checkout(tempBranch, 'HEAD')
// Commit any uncommitted changes // Commit any uncommitted changes
if (await git.isDirty(true)) { if (await git.isDirty(true, addPaths)) {
core.info('Uncommitted changes found. Adding a commit.') core.info('Uncommitted changes found. Adding a commit.')
for (const path of addPaths) { const aopts = ['add']
await git.exec(['add', path], true) if (addPaths.length > 0) {
aopts.push(...['--', ...addPaths])
} else {
aopts.push('-A')
} }
const params = ['-m', commitMessage] await git.exec(aopts, true)
const popts = ['-m', commitMessage]
if (signoff) { if (signoff) {
params.push('--signoff') popts.push('--signoff')
} }
await git.commit(params) await git.commit(popts)
}
// Remove uncommitted tracked and untracked changes // Remove uncommitted tracked and untracked changes
await git.exec(['reset', '--hard']) await git.exec(['reset', '--hard'])
await git.exec(['clean', '-f']) await git.exec(['clean', '-f', '-d'])
}
// Perform fetch and reset the working base // Perform fetch and reset the working base
// Commits made during the workflow will be removed // Commits made during the workflow will be removed

13
src/git-command-manager.ts
View file

@ -155,17 +155,22 @@ export class GitCommandManager {
return output.exitCode === 1 return output.exitCode === 1
} }
async isDirty(untracked: boolean): Promise<boolean> { async isDirty(untracked: boolean, pathspec?: string[]): Promise<boolean> {
const pathspecArgs = pathspec ? ['--', ...pathspec] : []
// Check untracked changes // Check untracked changes
if (untracked && (await this.status(['--porcelain', '-unormal']))) { const sargs = ['--porcelain', '-unormal']
sargs.push(...pathspecArgs)
if (untracked && (await this.status(sargs))) {
return true return true
} }
// Check working index changes // Check working index changes
if (await this.hasDiff()) { if (await this.hasDiff(pathspecArgs)) {
return true return true
} }
// Check staged changes // Check staged changes
if (await this.hasDiff(['--staged'])) { const dargs = ['--staged']
dargs.push(...pathspecArgs)
if (await this.hasDiff(dargs)) {
return true return true
} }
return false return false

6
src/main.ts
View file

@ -12,9 +12,9 @@ async function run(): Promise<void> {
commitMessage: core.getInput('commit-message'), commitMessage: core.getInput('commit-message'),
committer: core.getInput('committer'), committer: core.getInput('committer'),
author: core.getInput('author'), author: core.getInput('author'),
signoff: core.getInput('signoff') === 'true', signoff: core.getBooleanInput('signoff'),
branch: core.getInput('branch'), branch: core.getInput('branch'),
deleteBranch: core.getInput('delete-branch') === 'true', deleteBranch: core.getBooleanInput('delete-branch'),
branchSuffix: core.getInput('branch-suffix'), branchSuffix: core.getInput('branch-suffix'),
base: core.getInput('base'), base: core.getInput('base'),
pushToFork: core.getInput('push-to-fork'), pushToFork: core.getInput('push-to-fork'),
@ -25,7 +25,7 @@ async function run(): Promise<void> {
reviewers: utils.getInputAsArray('reviewers'), reviewers: utils.getInputAsArray('reviewers'),
teamReviewers: utils.getInputAsArray('team-reviewers'), teamReviewers: utils.getInputAsArray('team-reviewers'),
milestone: Number(core.getInput('milestone')), milestone: Number(core.getInput('milestone')),
draft: core.getInput('draft') === 'true' draft: core.getBooleanInput('draft')
} }
core.debug(`Inputs: ${inspect(inputs)}`) core.debug(`Inputs: ${inspect(inputs)}`)