mirror of
https://forgejo.stefka.eu/jiriks74/create-pull-request.git
synced 2025-01-18 16:01:06 +01:00
Merge pull request #1005 from tutu-ru-mobile/feature/add-pattern-array
Add argument add-pattern-array
This commit is contained in:
commit
59720dbe4f
7 changed files with 42 additions and 9 deletions
1
.gitignore
vendored
1
.gitignore
vendored
|
@ -2,3 +2,4 @@ lib/
|
||||||
node_modules/
|
node_modules/
|
||||||
|
|
||||||
.DS_Store
|
.DS_Store
|
||||||
|
.idea
|
||||||
|
|
17
README.md
17
README.md
|
@ -62,7 +62,8 @@ All inputs are **optional**. If not set, sensible defaults will be used.
|
||||||
| `reviewers` | A comma or newline-separated list of reviewers (GitHub usernames) to request a review from. | |
|
| `reviewers` | A comma or newline-separated list of reviewers (GitHub usernames) to request a review from. | |
|
||||||
| `team-reviewers` | A comma or newline-separated list of GitHub teams to request a review from. Note that a `repo` scoped [PAT](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) may be required. See [this issue](https://github.com/peter-evans/create-pull-request/issues/155). If using a GitHub App, refer to [Authenticating with GitHub App generated tokens](docs/concepts-guidelines.md#authenticating-with-github-app-generated-tokens) for the proper permissions. | |
|
| `team-reviewers` | A comma or newline-separated list of GitHub teams to request a review from. Note that a `repo` scoped [PAT](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) may be required. See [this issue](https://github.com/peter-evans/create-pull-request/issues/155). If using a GitHub App, refer to [Authenticating with GitHub App generated tokens](docs/concepts-guidelines.md#authenticating-with-github-app-generated-tokens) for the proper permissions. | |
|
||||||
| `milestone` | The number of the milestone to associate this pull request with. | |
|
| `milestone` | The number of the milestone to associate this pull request with. | |
|
||||||
| `draft` | Create a [draft pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests#draft-pull-requests). | `false` |
|
| `draft` | Create a [draft pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests#draft-pull-requests). | `false` | |
|
||||||
|
| `add-pattern-array` | A comma or newline-separated list of file path patterns, by example `**.txt, **some_dir**.png`. | `-A (what means --all)` |
|
||||||
|
|
||||||
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
|
||||||
|
@ -122,6 +123,20 @@ To use this strategy, set input `branch-suffix` with one of the following option
|
||||||
|
|
||||||
- `short-commit-hash` - Commits will be made to a branch suffixed with the short SHA1 commit hash. e.g. `create-pull-request/patch-fcdfb59`, `create-pull-request/patch-394710b`
|
- `short-commit-hash` - Commits will be made to a branch suffixed with the short SHA1 commit hash. e.g. `create-pull-request/patch-fcdfb59`, `create-pull-request/patch-394710b`
|
||||||
|
|
||||||
|
### Controlling committed files
|
||||||
|
|
||||||
|
You may control files to added on pull request with argument `add-pattern-array`.
|
||||||
|
It specify `git add` pattern of files. By example:
|
||||||
|
```yml
|
||||||
|
...
|
||||||
|
uses: peter-evans/create-pull-request@main #TODO put next version here
|
||||||
|
with:
|
||||||
|
add-pattern-array: |
|
||||||
|
**.txt
|
||||||
|
**some/dirs**.png
|
||||||
|
token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
```
|
||||||
|
|
||||||
### Controlling commits
|
### Controlling commits
|
||||||
|
|
||||||
As well as relying on the action to handle uncommitted changes, you can additionally make your own commits before the action runs.
|
As well as relying on the action to handle uncommitted changes, you can additionally make your own commits before the action runs.
|
||||||
|
|
|
@ -64,6 +64,10 @@ inputs:
|
||||||
draft:
|
draft:
|
||||||
description: 'Create a draft pull request'
|
description: 'Create a draft pull request'
|
||||||
default: false
|
default: false
|
||||||
|
add-pattern-array:
|
||||||
|
description: 'git add [pattern]'
|
||||||
|
default: |
|
||||||
|
-A
|
||||||
outputs:
|
outputs:
|
||||||
pull-request-number:
|
pull-request-number:
|
||||||
description: 'The pull request number'
|
description: 'The pull request number'
|
||||||
|
|
13
dist/index.js
vendored
13
dist/index.js
vendored
|
@ -98,7 +98,7 @@ function splitLines(multilineString) {
|
||||||
.map(s => s.trim())
|
.map(s => s.trim())
|
||||||
.filter(x => x !== '');
|
.filter(x => x !== '');
|
||||||
}
|
}
|
||||||
function createOrUpdateBranch(git, commitMessage, base, branch, branchRemoteName, signoff) {
|
function createOrUpdateBranch(git, commitMessage, base, branch, branchRemoteName, signoff, filePatterns) {
|
||||||
return __awaiter(this, void 0, void 0, function* () {
|
return __awaiter(this, void 0, void 0, function* () {
|
||||||
// Get the working base.
|
// Get the working base.
|
||||||
// When a ref, it may or may not be the actual base.
|
// When a ref, it may or may not be the actual base.
|
||||||
|
@ -124,12 +124,16 @@ function createOrUpdateBranch(git, commitMessage, base, branch, branchRemoteName
|
||||||
// Commit any uncommitted changes
|
// Commit any uncommitted changes
|
||||||
if (yield git.isDirty(true)) {
|
if (yield git.isDirty(true)) {
|
||||||
core.info('Uncommitted changes found. Adding a commit.');
|
core.info('Uncommitted changes found. Adding a commit.');
|
||||||
yield git.exec(['add', '-A']);
|
for (const filePattern of filePatterns) {
|
||||||
|
yield git.exec(['add', filePattern], true);
|
||||||
|
}
|
||||||
const params = ['-m', commitMessage];
|
const params = ['-m', commitMessage];
|
||||||
if (signoff) {
|
if (signoff) {
|
||||||
params.push('--signoff');
|
params.push('--signoff');
|
||||||
}
|
}
|
||||||
yield git.commit(params);
|
yield git.commit(params);
|
||||||
|
git.exec(['reset', '--hard']);
|
||||||
|
git.exec(['clean', '-f']);
|
||||||
}
|
}
|
||||||
// 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
|
||||||
|
@ -377,7 +381,7 @@ function createPullRequest(inputs) {
|
||||||
core.endGroup();
|
core.endGroup();
|
||||||
// Create or update the pull request branch
|
// Create or update the pull request branch
|
||||||
core.startGroup('Create or update the pull request branch');
|
core.startGroup('Create or update the pull request branch');
|
||||||
const result = yield (0, create_or_update_branch_1.createOrUpdateBranch)(git, inputs.commitMessage, inputs.base, inputs.branch, branchRemoteName, inputs.signoff);
|
const result = yield (0, create_or_update_branch_1.createOrUpdateBranch)(git, inputs.commitMessage, inputs.base, inputs.branch, branchRemoteName, inputs.signoff, inputs.addPatternArray);
|
||||||
core.endGroup();
|
core.endGroup();
|
||||||
if (['created', 'updated'].includes(result.action)) {
|
if (['created', 'updated'].includes(result.action)) {
|
||||||
// The branch was created or updated
|
// The branch was created or updated
|
||||||
|
@ -1090,7 +1094,8 @@ 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.getInput('draft') === 'true',
|
||||||
|
addPatternArray: utils.getInputAsArray('add-pattern-array')
|
||||||
};
|
};
|
||||||
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);
|
||||||
|
|
|
@ -91,7 +91,8 @@ export async function createOrUpdateBranch(
|
||||||
base: string,
|
base: string,
|
||||||
branch: string,
|
branch: string,
|
||||||
branchRemoteName: string,
|
branchRemoteName: string,
|
||||||
signoff: boolean
|
signoff: boolean,
|
||||||
|
filePatterns: string[]
|
||||||
): Promise<CreateOrUpdateBranchResult> {
|
): Promise<CreateOrUpdateBranchResult> {
|
||||||
// Get the working base.
|
// Get the working base.
|
||||||
// When a ref, it may or may not be the actual base.
|
// When a ref, it may or may not be the actual base.
|
||||||
|
@ -120,12 +121,16 @@ export async function createOrUpdateBranch(
|
||||||
// Commit any uncommitted changes
|
// Commit any uncommitted changes
|
||||||
if (await git.isDirty(true)) {
|
if (await git.isDirty(true)) {
|
||||||
core.info('Uncommitted changes found. Adding a commit.')
|
core.info('Uncommitted changes found. Adding a commit.')
|
||||||
await git.exec(['add', '-A'])
|
for (const filePattern of filePatterns) {
|
||||||
|
await git.exec(['add', filePattern], true)
|
||||||
|
}
|
||||||
const params = ['-m', commitMessage]
|
const params = ['-m', commitMessage]
|
||||||
if (signoff) {
|
if (signoff) {
|
||||||
params.push('--signoff')
|
params.push('--signoff')
|
||||||
}
|
}
|
||||||
await git.commit(params)
|
await git.commit(params)
|
||||||
|
git.exec(['reset', '--hard'])
|
||||||
|
git.exec(['clean', '-f'])
|
||||||
}
|
}
|
||||||
|
|
||||||
// Perform fetch and reset the working base
|
// Perform fetch and reset the working base
|
||||||
|
|
|
@ -29,6 +29,7 @@ export interface Inputs {
|
||||||
teamReviewers: string[]
|
teamReviewers: string[]
|
||||||
milestone: number
|
milestone: number
|
||||||
draft: boolean
|
draft: boolean
|
||||||
|
addPatternArray: string[]
|
||||||
}
|
}
|
||||||
|
|
||||||
export async function createPullRequest(inputs: Inputs): Promise<void> {
|
export async function createPullRequest(inputs: Inputs): Promise<void> {
|
||||||
|
@ -173,7 +174,8 @@ export async function createPullRequest(inputs: Inputs): Promise<void> {
|
||||||
inputs.base,
|
inputs.base,
|
||||||
inputs.branch,
|
inputs.branch,
|
||||||
branchRemoteName,
|
branchRemoteName,
|
||||||
inputs.signoff
|
inputs.signoff,
|
||||||
|
inputs.addPatternArray
|
||||||
)
|
)
|
||||||
core.endGroup()
|
core.endGroup()
|
||||||
|
|
||||||
|
|
|
@ -24,7 +24,8 @@ 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.getInput('draft') === 'true',
|
||||||
|
addPatternArray: utils.getInputAsArray('add-pattern-array')
|
||||||
}
|
}
|
||||||
core.debug(`Inputs: ${inspect(inputs)}`)
|
core.debug(`Inputs: ${inspect(inputs)}`)
|
||||||
|
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue