Skip to content

Commit

Permalink
Add input to exclude drafts
Browse files Browse the repository at this point in the history
  • Loading branch information
@peter-evans
peter-evans committed Oct 8, 2021
1 parent a9e5aca commit 0257082
Show file tree
Hide file tree
Showing 5 changed files with 24 additions and 9 deletions.
1 change: 1 addition & 0 deletions README.md
View file
Expand Up @@ -64,6 +64,7 @@ jobs:
| `head` | Filter pull requests by head user or head organization and branch name in the format `user:ref-name` or `organization:ref-name`. Use the `*` wildcard match any ref. e.g. `my-org:new-script-format` or `octocat:*`. | |
| `base` | Filter pull requests by base branch name. Example: `gh-pages`. | |
| `exclude-labels` | A comma or newline separated list of pull request labels to exclude. | |
| `exclude-drafts` | Exclude draft pull requests. | `false` |

### Rebase slash command

Expand Down
3 changes: 3 additions & 0 deletions action.yml
View file
Expand Up @@ -17,6 +17,9 @@ inputs:
Example: gh-pages.
exclude-labels:
description: 'A comma or newline separated list of pull request labels to exclude'
exclude-drafts:
description: 'Exclude draft pull requests'
default: false
runs:
using: 'node12'
main: 'dist/index.js'
Expand Down
14 changes: 9 additions & 5 deletions dist/index.js
View file
Expand Up @@ -5,7 +5,7 @@
/***/ ((module) => {

"use strict";
module.exports = JSON.parse('{"name":"@octokit/rest","version":"16.43.2","publishConfig":{"access":"public"},"description":"GitHub REST API client for Node.js","keywords":["octokit","github","rest","api-client"],"author":"Gregor Martynus (https://github.com/gr2m)","contributors":[{"name":"Mike de Boer","email":"info@mikedeboer.nl"},{"name":"Fabian Jakobs","email":"fabian@c9.io"},{"name":"Joe Gallo","email":"joe@brassafrax.com"},{"name":"Gregor Martynus","url":"https://github.com/gr2m"}],"repository":"https://github.com/octokit/rest.js","dependencies":{"@octokit/auth-token":"^2.4.0","@octokit/plugin-paginate-rest":"^1.1.1","@octokit/plugin-request-log":"^1.0.0","@octokit/plugin-rest-endpoint-methods":"2.4.0","@octokit/request":"^5.2.0","@octokit/request-error":"^1.0.2","atob-lite":"^2.0.0","before-after-hook":"^2.0.0","btoa-lite":"^1.0.0","deprecation":"^2.0.0","lodash.get":"^4.4.2","lodash.set":"^4.3.2","lodash.uniq":"^4.5.0","octokit-pagination-methods":"^1.1.0","once":"^1.4.0","universal-user-agent":"^4.0.0"},"devDependencies":{"@gimenete/type-writer":"^0.1.3","@octokit/auth":"^1.1.1","@octokit/fixtures-server":"^5.0.6","@octokit/graphql":"^4.2.0","@types/node":"^13.1.0","bundlesize":"^0.18.0","chai":"^4.1.2","compression-webpack-plugin":"^3.1.0","cypress":"^4.0.0","glob":"^7.1.2","http-proxy-agent":"^4.0.0","lodash.camelcase":"^4.3.0","lodash.merge":"^4.6.1","lodash.upperfirst":"^4.3.1","lolex":"^6.0.0","mkdirp":"^1.0.0","mocha":"^7.0.1","mustache":"^4.0.0","nock":"^11.3.3","npm-run-all":"^4.1.2","nyc":"^15.0.0","prettier":"^1.14.2","proxy":"^1.0.0","semantic-release":"^17.0.0","sinon":"^8.0.0","sinon-chai":"^3.0.0","sort-keys":"^4.0.0","string-to-arraybuffer":"^1.0.0","string-to-jsdoc-comment":"^1.0.0","typescript":"^3.3.1","webpack":"^4.0.0","webpack-bundle-analyzer":"^3.0.0","webpack-cli":"^3.0.0"},"types":"index.d.ts","scripts":{"coverage":"nyc report --reporter=html && open coverage/index.html","lint":"prettier --check \'{lib,plugins,scripts,test}/**/*.{js,json,ts}\' \'docs/*.{js,json}\' \'docs/src/**/*\' index.js README.md package.json","lint:fix":"prettier --write \'{lib,plugins,scripts,test}/**/*.{js,json,ts}\' \'docs/*.{js,json}\' \'docs/src/**/*\' index.js README.md package.json","pretest":"npm run -s lint","test":"nyc mocha test/mocha-node-setup.js \\"test/*/**/*-test.js\\"","test:browser":"cypress run --browser chrome","build":"npm-run-all build:*","build:ts":"npm run -s update-endpoints:typescript","prebuild:browser":"mkdirp dist/","build:browser":"npm-run-all build:browser:*","build:browser:development":"webpack --mode development --entry . --output-library=Octokit --output=./dist/octokit-rest.js --profile --json > dist/bundle-stats.json","build:browser:production":"webpack --mode production --entry . --plugin=compression-webpack-plugin --output-library=Octokit --output-path=./dist --output-filename=octokit-rest.min.js --devtool source-map","generate-bundle-report":"webpack-bundle-analyzer dist/bundle-stats.json --mode=static --no-open --report dist/bundle-report.html","update-endpoints":"npm-run-all update-endpoints:*","update-endpoints:fetch-json":"node scripts/update-endpoints/fetch-json","update-endpoints:typescript":"node scripts/update-endpoints/typescript","prevalidate:ts":"npm run -s build:ts","validate:ts":"tsc --target es6 --noImplicitAny index.d.ts","postvalidate:ts":"tsc --noEmit --target es6 test/typescript-validate.ts","start-fixtures-server":"octokit-fixtures-server"},"license":"MIT","files":["index.js","index.d.ts","lib","plugins"],"nyc":{"ignore":["test"]},"release":{"publish":["@semantic-release/npm",{"path":"@semantic-release/github","assets":["dist/*","!dist/*.map.gz"]}]},"bundlesize":[{"path":"./dist/octokit-rest.min.js.gz","maxSize":"33 kB"}],"_resolved":"https://registry.npmjs.org/@octokit/rest/-/rest-16.43.2.tgz","_integrity":"sha512-ngDBevLbBTFfrHZeiS7SAMAZ6ssuVmXuya+F/7RaVvlysgGa1JKJkKWY+jV6TCJYcW0OALfJ7nTIGXcBXzycfQ==","_from":"@octokit/rest@16.43.2"}');
module.exports = JSON.parse('{"name":"@octokit/rest","version":"16.43.2","publishConfig":{"access":"public"},"description":"GitHub REST API client for Node.js","keywords":["octokit","github","rest","api-client"],"author":"Gregor Martynus (https://github.com/gr2m)","contributors":[{"name":"Mike de Boer","email":"info@mikedeboer.nl"},{"name":"Fabian Jakobs","email":"fabian@c9.io"},{"name":"Joe Gallo","email":"joe@brassafrax.com"},{"name":"Gregor Martynus","url":"https://github.com/gr2m"}],"repository":"https://github.com/octokit/rest.js","dependencies":{"@octokit/auth-token":"^2.4.0","@octokit/plugin-paginate-rest":"^1.1.1","@octokit/plugin-request-log":"^1.0.0","@octokit/plugin-rest-endpoint-methods":"2.4.0","@octokit/request":"^5.2.0","@octokit/request-error":"^1.0.2","atob-lite":"^2.0.0","before-after-hook":"^2.0.0","btoa-lite":"^1.0.0","deprecation":"^2.0.0","lodash.get":"^4.4.2","lodash.set":"^4.3.2","lodash.uniq":"^4.5.0","octokit-pagination-methods":"^1.1.0","once":"^1.4.0","universal-user-agent":"^4.0.0"},"devDependencies":{"@gimenete/type-writer":"^0.1.3","@octokit/auth":"^1.1.1","@octokit/fixtures-server":"^5.0.6","@octokit/graphql":"^4.2.0","@types/node":"^13.1.0","bundlesize":"^0.18.0","chai":"^4.1.2","compression-webpack-plugin":"^3.1.0","cypress":"^4.0.0","glob":"^7.1.2","http-proxy-agent":"^4.0.0","lodash.camelcase":"^4.3.0","lodash.merge":"^4.6.1","lodash.upperfirst":"^4.3.1","lolex":"^6.0.0","mkdirp":"^1.0.0","mocha":"^7.0.1","mustache":"^4.0.0","nock":"^11.3.3","npm-run-all":"^4.1.2","nyc":"^15.0.0","prettier":"^1.14.2","proxy":"^1.0.0","semantic-release":"^17.0.0","sinon":"^8.0.0","sinon-chai":"^3.0.0","sort-keys":"^4.0.0","string-to-arraybuffer":"^1.0.0","string-to-jsdoc-comment":"^1.0.0","typescript":"^3.3.1","webpack":"^4.0.0","webpack-bundle-analyzer":"^3.0.0","webpack-cli":"^3.0.0"},"types":"index.d.ts","scripts":{"coverage":"nyc report --reporter=html && open coverage/index.html","lint":"prettier --check \'{lib,plugins,scripts,test}/**/*.{js,json,ts}\' \'docs/*.{js,json}\' \'docs/src/**/*\' index.js README.md package.json","lint:fix":"prettier --write \'{lib,plugins,scripts,test}/**/*.{js,json,ts}\' \'docs/*.{js,json}\' \'docs/src/**/*\' index.js README.md package.json","pretest":"npm run -s lint","test":"nyc mocha test/mocha-node-setup.js \\"test/*/**/*-test.js\\"","test:browser":"cypress run --browser chrome","build":"npm-run-all build:*","build:ts":"npm run -s update-endpoints:typescript","prebuild:browser":"mkdirp dist/","build:browser":"npm-run-all build:browser:*","build:browser:development":"webpack --mode development --entry . --output-library=Octokit --output=./dist/octokit-rest.js --profile --json > dist/bundle-stats.json","build:browser:production":"webpack --mode production --entry . --plugin=compression-webpack-plugin --output-library=Octokit --output-path=./dist --output-filename=octokit-rest.min.js --devtool source-map","generate-bundle-report":"webpack-bundle-analyzer dist/bundle-stats.json --mode=static --no-open --report dist/bundle-report.html","update-endpoints":"npm-run-all update-endpoints:*","update-endpoints:fetch-json":"node scripts/update-endpoints/fetch-json","update-endpoints:typescript":"node scripts/update-endpoints/typescript","prevalidate:ts":"npm run -s build:ts","validate:ts":"tsc --target es6 --noImplicitAny index.d.ts","postvalidate:ts":"tsc --noEmit --target es6 test/typescript-validate.ts","start-fixtures-server":"octokit-fixtures-server"},"license":"MIT","files":["index.js","index.d.ts","lib","plugins"],"nyc":{"ignore":["test"]},"release":{"publish":["@semantic-release/npm",{"path":"@semantic-release/github","assets":["dist/*","!dist/*.map.gz"]}]},"bundlesize":[{"path":"./dist/octokit-rest.min.js.gz","maxSize":"33 kB"}]}');

/***/ }),

Expand Down Expand Up @@ -389,12 +389,13 @@ function run() {
repository: core.getInput('repository'),
head: core.getInput('head'),
base: core.getInput('base'),
excludeLabels: utils.getInputAsArray('exclude-labels')
excludeLabels: utils.getInputAsArray('exclude-labels'),
excludeDrafts: core.getInput('exclude-drafts') === 'true'
};
core.debug(`Inputs: ${util_1.inspect(inputs)}`);
const [headOwner, head] = inputValidator.parseHead(inputs.head);
const pullsHelper = new pulls_helper_1.PullsHelper(inputs.token);
const pulls = yield pullsHelper.get(inputs.repository, head, headOwner, inputs.base, inputs.excludeLabels);
const pulls = yield pullsHelper.get(inputs.repository, head, headOwner, inputs.base, inputs.excludeLabels, inputs.excludeDrafts);
if (pulls.length > 0) {
core.info(`${pulls.length} pull request(s) found.`);
// Checkout
Expand Down Expand Up @@ -481,7 +482,7 @@ class PullsHelper {
}
});
}
get(repository, head, headOwner, base, excludeLabels) {
get(repository, head, headOwner, base, excludeLabels, excludeDrafts) {
return __awaiter(this, void 0, void 0, function* () {
const [owner, repo] = repository.split('/');
const params = {
Expand All @@ -506,6 +507,7 @@ class PullsHelper {
headRepositoryOwner {
login
}
isDraft
labels(first: 100) {
nodes {
name
Expand Down Expand Up @@ -534,7 +536,9 @@ class PullsHelper {
p.node.labels.nodes.every(function (value) {
// Label is not in the exclude list
return !excludeLabels.includes(value.name);
})) {
}) &&
// Filter out drafts if set to exclude
(!excludeDrafts || p.node.isDraft == false)) {
return new Pull(p.node.baseRefName, p.node.headRepository.url, p.node.headRepository.nameWithOwner, p.node.headRefName);
}
})
Expand Down
6 changes: 4 additions & 2 deletions src/main.ts
View file
Expand Up @@ -17,7 +17,8 @@ async function run(): Promise<void> {
repository: core.getInput('repository'),
head: core.getInput('head'),
base: core.getInput('base'),
excludeLabels: utils.getInputAsArray('exclude-labels')
excludeLabels: utils.getInputAsArray('exclude-labels'),
excludeDrafts: core.getInput('exclude-drafts') === 'true'
}
core.debug(`Inputs: ${inspect(inputs)}`)

Expand All @@ -29,7 +30,8 @@ async function run(): Promise<void> {
head,
headOwner,
inputs.base,
inputs.excludeLabels
inputs.excludeLabels,
inputs.excludeDrafts
)

if (pulls.length > 0) {
Expand Down
9 changes: 7 additions & 2 deletions src/pulls-helper.ts
View file
Expand Up @@ -20,7 +20,8 @@ export class PullsHelper {
head: string,
headOwner: string,
base: string,
excludeLabels: string[]
excludeLabels: string[],
excludeDrafts: boolean
): Promise<Pull[]> {
const [owner, repo] = repository.split('/')
const params: OctokitTypes.RequestParameters = {
Expand All @@ -43,6 +44,7 @@ export class PullsHelper {
headRepositoryOwner {
login
}
isDraft
labels(first: 100) {
nodes {
name
Expand Down Expand Up @@ -72,7 +74,9 @@ export class PullsHelper {
p.node.labels.nodes.every(function (value: Label): boolean {
// Label is not in the exclude list
return !excludeLabels.includes(value.name)
})
}) &&
// Filter out drafts if set to exclude
(!excludeDrafts || p.node.isDraft == false)
) {
return new Pull(
p.node.baseRefName,
Expand Down Expand Up @@ -104,6 +108,7 @@ type Edge = {
headRepositoryOwner: {
login: string
}
isDraft: boolean
labels: {
nodes: Label[]
}
Expand Down

0 comments on commit 0257082

Please sign in to comment.