Get it working (#2)
* Get it working (#1) * Get it working * Required token * Logging * Debug * Debug * Correct logging * No setNeutral * debug * debug * debug * debug * debug * debug * debug * debug * debug * debug * debug * working * logging * logging * logging * logging * logging * logging * logging * logging * logging * logging * debug * debug * Logging * Dont validate issues against prs * Inputs should be snake cased * Add example usage * Respond to some feedback, some still left * Respond to rest of feedback * Fix period
This commit is contained in:
@@ -1,3 +1,20 @@
|
|||||||
# Container Action Template
|
# First Interaction
|
||||||
|
|
||||||
To get started, click the `Use this template` button on this repository [which will create a new repository based on this template](https://github.blog/2019-06-06-generate-new-repositories-with-repository-templates/).
|
An action for filtering pull requests and issues from first-time contributors.
|
||||||
|
|
||||||
|
# Usage
|
||||||
|
|
||||||
|
See [action.yml](action.yml)
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
steps:
|
||||||
|
- uses: actions/first-interaction@v1
|
||||||
|
with:
|
||||||
|
repo-token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
issue-message: '# Mesage with markdown.\nThis is the message that will be displayed on users' first issue.'
|
||||||
|
pr-message: 'Message that will be displayed on users' first pr. Look, a `code block` for markdown.'
|
||||||
|
```
|
||||||
|
|
||||||
|
# License
|
||||||
|
|
||||||
|
The scripts and documentation in this project are released under the [MIT License](LICENSE)
|
||||||
|
|||||||
@@ -1,4 +0,0 @@
|
|||||||
describe('TODO - Add a test suite', () => {
|
|
||||||
it('TODO - Add a test', async () => {
|
|
||||||
});
|
|
||||||
});
|
|
||||||
+9
-5
@@ -1,10 +1,14 @@
|
|||||||
name: 'Container Action Template'
|
name: 'First interaction'
|
||||||
description: 'Get started with Container actions'
|
description: 'Get started with Container actions'
|
||||||
author: 'GitHub'
|
author: 'GitHub'
|
||||||
inputs:
|
inputs:
|
||||||
myInput:
|
repo-token:
|
||||||
description: 'Input to use'
|
description: 'Token for the repo. Can be passed in using {{ secrets.GITHUB_TOKEN }}'
|
||||||
default: 'world'
|
required: true
|
||||||
|
issue-message:
|
||||||
|
description: 'Comment to post on an individuals first issue'
|
||||||
|
pr-message:
|
||||||
|
description: 'Comment to post on an individuals first pull request'
|
||||||
runs:
|
runs:
|
||||||
using: 'docker'
|
using: 'docker'
|
||||||
image: 'Dockerfile'
|
image: 'Dockerfile'
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
module.exports = {
|
|
||||||
clearMocks: true,
|
|
||||||
moduleFileExtensions: ['js', 'ts'],
|
|
||||||
testEnvironment: 'node',
|
|
||||||
testMatch: ['**/*.test.ts'],
|
|
||||||
testRunner: 'jest-circus/runner',
|
|
||||||
transform: {
|
|
||||||
'^.+\\.ts$': 'ts-jest'
|
|
||||||
},
|
|
||||||
verbose: true
|
|
||||||
}
|
|
||||||
+121
-6
@@ -7,20 +7,135 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|||||||
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
||||||
});
|
});
|
||||||
};
|
};
|
||||||
const core = require('@actions/core');
|
var __importStar = (this && this.__importStar) || function (mod) {
|
||||||
const github = require('@actions/github');
|
if (mod && mod.__esModule) return mod;
|
||||||
|
var result = {};
|
||||||
|
if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) result[k] = mod[k];
|
||||||
|
result["default"] = mod;
|
||||||
|
return result;
|
||||||
|
};
|
||||||
|
Object.defineProperty(exports, "__esModule", { value: true });
|
||||||
|
const core = __importStar(require("@actions/core"));
|
||||||
|
const github = __importStar(require("@actions/github"));
|
||||||
function run() {
|
function run() {
|
||||||
return __awaiter(this, void 0, void 0, function* () {
|
return __awaiter(this, void 0, void 0, function* () {
|
||||||
try {
|
try {
|
||||||
const myInput = core.getInput('myInput');
|
const issueMessage = core.getInput('issue-message');
|
||||||
core.debug(`Hello ${myInput} from inside a container`);
|
const prMessage = core.getInput('pr-message');
|
||||||
// Get github context data
|
if (!issueMessage && !prMessage) {
|
||||||
|
throw new Error('Action must have at least one of issue-message or pr-message set');
|
||||||
|
}
|
||||||
|
// Get client and context
|
||||||
|
const client = new github.GitHub(core.getInput('repo-token', { required: true }));
|
||||||
const context = github.context;
|
const context = github.context;
|
||||||
console.log(`We can even get context data, like the repo: ${context.repo.repo}`);
|
if (context.payload.action !== 'opened') {
|
||||||
|
console.log('No issue or PR was opened, skipping');
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
// Do nothing if its not a pr or issue
|
||||||
|
const isIssue = !!context.payload.issue;
|
||||||
|
if (!isIssue && !context.payload.pull_request) {
|
||||||
|
console.log('The event that triggered this action was not a pull request or issue, skipping.');
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
// Do nothing if its not their first contribution
|
||||||
|
console.log('Checking if its the users first contribution');
|
||||||
|
if (!context.payload.sender) {
|
||||||
|
throw new Error('Internal error, no sender provided by GitHub');
|
||||||
|
}
|
||||||
|
const sender = context.payload.sender.login;
|
||||||
|
const issue = context.issue;
|
||||||
|
let firstContribution = false;
|
||||||
|
if (isIssue) {
|
||||||
|
firstContribution = yield isFirstIssue(client, issue.owner, issue.repo, sender, issue.number);
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
firstContribution = yield isFirstPull(client, issue.owner, issue.repo, sender, issue.number);
|
||||||
|
}
|
||||||
|
if (!firstContribution) {
|
||||||
|
console.log('Not the users first contribution');
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
// Do nothing if no message set for this type of contribution
|
||||||
|
const message = isIssue ? issueMessage : prMessage;
|
||||||
|
if (!message) {
|
||||||
|
console.log('No message provided for this type of contribution');
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
const issueType = isIssue ? 'issue' : 'pull request';
|
||||||
|
// Add a comment to the appropriate place
|
||||||
|
console.log(`Adding message: ${message} to ${issueType} ${issue.number}`);
|
||||||
|
if (isIssue) {
|
||||||
|
yield client.issues.createComment({
|
||||||
|
owner: issue.owner,
|
||||||
|
repo: issue.repo,
|
||||||
|
issue_number: issue.number,
|
||||||
|
body: message
|
||||||
|
});
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
yield client.pulls.createReview({
|
||||||
|
owner: issue.owner,
|
||||||
|
repo: issue.repo,
|
||||||
|
pull_number: issue.number,
|
||||||
|
body: message,
|
||||||
|
event: 'COMMENT'
|
||||||
|
});
|
||||||
|
}
|
||||||
}
|
}
|
||||||
catch (error) {
|
catch (error) {
|
||||||
core.setFailed(error.message);
|
core.setFailed(error.message);
|
||||||
|
return;
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
function isFirstIssue(client, owner, repo, sender, curIssueNumber) {
|
||||||
|
return __awaiter(this, void 0, void 0, function* () {
|
||||||
|
const { status, data: issues } = yield client.issues.listForRepo({
|
||||||
|
owner: owner,
|
||||||
|
repo: repo,
|
||||||
|
creator: sender,
|
||||||
|
state: 'all'
|
||||||
|
});
|
||||||
|
if (status !== 200) {
|
||||||
|
throw new Error(`Received unexpected API status code ${status}`);
|
||||||
|
}
|
||||||
|
if (issues.length === 0) {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
for (const issue of issues) {
|
||||||
|
if (issue.number < curIssueNumber && !issue.pull_request) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return true;
|
||||||
|
});
|
||||||
|
}
|
||||||
|
// No way to filter pulls by creator
|
||||||
|
function isFirstPull(client, owner, repo, sender, curPullNumber, page = 1) {
|
||||||
|
return __awaiter(this, void 0, void 0, function* () {
|
||||||
|
// Provide console output if we loop for a while.
|
||||||
|
console.log('Checking...');
|
||||||
|
const { status, data: pulls } = yield client.pulls.list({
|
||||||
|
owner: owner,
|
||||||
|
repo: repo,
|
||||||
|
per_page: 100,
|
||||||
|
page: page,
|
||||||
|
state: 'all'
|
||||||
|
});
|
||||||
|
if (status !== 200) {
|
||||||
|
throw new Error(`Received unexpected API status code ${status}`);
|
||||||
|
}
|
||||||
|
if (pulls.length === 0) {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
for (const pull of pulls) {
|
||||||
|
const login = pull.user.login;
|
||||||
|
if (login === sender && pull.number < curPullNumber) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return yield isFirstPull(client, owner, repo, sender, curPullNumber, page + 1);
|
||||||
|
});
|
||||||
|
}
|
||||||
run();
|
run();
|
||||||
|
|||||||
+1
-1
@@ -26,9 +26,9 @@
|
|||||||
"homepage": "https://github.com/actions/container-toolkit-template#readme",
|
"homepage": "https://github.com/actions/container-toolkit-template#readme",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@actions/core": "file:toolkit/actions-core-0.0.0.tgz",
|
"@actions/core": "file:toolkit/actions-core-0.0.0.tgz",
|
||||||
"@actions/io": "file:toolkit/actions-io-0.0.0.tgz",
|
|
||||||
"@actions/exec": "file:toolkit/actions-exec-0.0.0.tgz",
|
"@actions/exec": "file:toolkit/actions-exec-0.0.0.tgz",
|
||||||
"@actions/github": "file:toolkit/actions-github-0.0.0.tgz",
|
"@actions/github": "file:toolkit/actions-github-0.0.0.tgz",
|
||||||
|
"@actions/io": "file:toolkit/actions-io-0.0.0.tgz",
|
||||||
"@actions/tool-cache": "file:toolkit/actions-tool-cache-0.0.0.tgz"
|
"@actions/tool-cache": "file:toolkit/actions-tool-cache-0.0.0.tgz"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
|
|||||||
+160
-7
@@ -1,17 +1,170 @@
|
|||||||
const core = require('@actions/core');
|
import * as core from '@actions/core';
|
||||||
const github = require('@actions/github');
|
import * as github from '@actions/github';
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
try {
|
try {
|
||||||
const myInput = core.getInput('myInput');
|
const issueMessage: string = core.getInput('issue-message');
|
||||||
core.debug(`Hello ${myInput} from inside a container`);
|
const prMessage: string = core.getInput('pr-message');
|
||||||
|
if (!issueMessage && !prMessage) {
|
||||||
// Get github context data
|
throw new Error(
|
||||||
|
'Action must have at least one of issue-message or pr-message set'
|
||||||
|
);
|
||||||
|
}
|
||||||
|
// Get client and context
|
||||||
|
const client: github.GitHub = new github.GitHub(
|
||||||
|
core.getInput('repo-token', {required: true})
|
||||||
|
);
|
||||||
const context = github.context;
|
const context = github.context;
|
||||||
console.log(`We can even get context data, like the repo: ${context.repo.repo}`)
|
|
||||||
|
if (context.payload.action !== 'opened') {
|
||||||
|
console.log('No issue or PR was opened, skipping');
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Do nothing if its not a pr or issue
|
||||||
|
const isIssue: boolean = !!context.payload.issue;
|
||||||
|
if (!isIssue && !context.payload.pull_request) {
|
||||||
|
console.log(
|
||||||
|
'The event that triggered this action was not a pull request or issue, skipping.'
|
||||||
|
);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Do nothing if its not their first contribution
|
||||||
|
console.log('Checking if its the users first contribution');
|
||||||
|
if (!context.payload.sender) {
|
||||||
|
throw new Error('Internal error, no sender provided by GitHub');
|
||||||
|
}
|
||||||
|
const sender: string = context.payload.sender!.login;
|
||||||
|
const issue: {owner: string; repo: string; number: number} = context.issue;
|
||||||
|
let firstContribution: boolean = false;
|
||||||
|
if (isIssue) {
|
||||||
|
firstContribution = await isFirstIssue(
|
||||||
|
client,
|
||||||
|
issue.owner,
|
||||||
|
issue.repo,
|
||||||
|
sender,
|
||||||
|
issue.number
|
||||||
|
);
|
||||||
|
} else {
|
||||||
|
firstContribution = await isFirstPull(
|
||||||
|
client,
|
||||||
|
issue.owner,
|
||||||
|
issue.repo,
|
||||||
|
sender,
|
||||||
|
issue.number
|
||||||
|
);
|
||||||
|
}
|
||||||
|
if (!firstContribution) {
|
||||||
|
console.log('Not the users first contribution');
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Do nothing if no message set for this type of contribution
|
||||||
|
const message: string = isIssue ? issueMessage : prMessage;
|
||||||
|
if (!message) {
|
||||||
|
console.log('No message provided for this type of contribution');
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const issueType: string = isIssue ? 'issue' : 'pull request';
|
||||||
|
// Add a comment to the appropriate place
|
||||||
|
console.log(`Adding message: ${message} to ${issueType} ${issue.number}`);
|
||||||
|
if (isIssue) {
|
||||||
|
await client.issues.createComment({
|
||||||
|
owner: issue.owner,
|
||||||
|
repo: issue.repo,
|
||||||
|
issue_number: issue.number,
|
||||||
|
body: message
|
||||||
|
});
|
||||||
|
} else {
|
||||||
|
await client.pulls.createReview({
|
||||||
|
owner: issue.owner,
|
||||||
|
repo: issue.repo,
|
||||||
|
pull_number: issue.number,
|
||||||
|
body: message,
|
||||||
|
event: 'COMMENT'
|
||||||
|
});
|
||||||
|
}
|
||||||
} catch (error) {
|
} catch (error) {
|
||||||
core.setFailed(error.message);
|
core.setFailed(error.message);
|
||||||
|
return;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
async function isFirstIssue(
|
||||||
|
client: github.GitHub,
|
||||||
|
owner: string,
|
||||||
|
repo: string,
|
||||||
|
sender: string,
|
||||||
|
curIssueNumber: number
|
||||||
|
): Promise<boolean> {
|
||||||
|
const {status, data: issues} = await client.issues.listForRepo({
|
||||||
|
owner: owner,
|
||||||
|
repo: repo,
|
||||||
|
creator: sender,
|
||||||
|
state: 'all'
|
||||||
|
});
|
||||||
|
|
||||||
|
if (status !== 200) {
|
||||||
|
throw new Error(`Received unexpected API status code ${status}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (issues.length === 0) {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
for (const issue of issues) {
|
||||||
|
if (issue.number < curIssueNumber && !issue.pull_request) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
// No way to filter pulls by creator
|
||||||
|
async function isFirstPull(
|
||||||
|
client: github.GitHub,
|
||||||
|
owner: string,
|
||||||
|
repo: string,
|
||||||
|
sender: string,
|
||||||
|
curPullNumber: number,
|
||||||
|
page: number = 1
|
||||||
|
): Promise<boolean> {
|
||||||
|
// Provide console output if we loop for a while.
|
||||||
|
console.log('Checking...');
|
||||||
|
const {status, data: pulls} = await client.pulls.list({
|
||||||
|
owner: owner,
|
||||||
|
repo: repo,
|
||||||
|
per_page: 100,
|
||||||
|
page: page,
|
||||||
|
state: 'all'
|
||||||
|
});
|
||||||
|
|
||||||
|
if (status !== 200) {
|
||||||
|
throw new Error(`Received unexpected API status code ${status}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (pulls.length === 0) {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
for (const pull of pulls) {
|
||||||
|
const login: string = pull.user.login;
|
||||||
|
if (login === sender && pull.number < curPullNumber) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return await isFirstPull(
|
||||||
|
client,
|
||||||
|
owner,
|
||||||
|
repo,
|
||||||
|
sender,
|
||||||
|
curPullNumber,
|
||||||
|
page + 1
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
run();
|
run();
|
||||||
|
|||||||
Binary file not shown.
Reference in New Issue
Block a user