Skip to content

Added welcome-first-time-contributor.yml #360

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 71 additions & 0 deletions .github/scripts/welcome-first-time-contributor.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@

const core = require('@actions/core');
const github = require('@actions/github');

async function run() {
const context = github.context;

const issueMessage = `Welcome to Accord. Thanks a lot for reporting your first issue. Please check out our [contributors guide](https://github.com/accordproject/techdocs/blob/main/CONTRIBUTING.md).<br />Keep in mind there are also other channels you can use to interact with the Accord community. For more details check out our [Discord](https://discord.com/invite/Zm99SKhhtA).`;

const prMessage = `Welcome to Accord. Thanks a lot for creating your first pull request. Please check out our [contributors guide](https://github.com/accordproject/techdocs/blob/main/CONTRIBUTING.md).<br />Keep in mind there are also other channels you can use to interact with the Accord community. For more details check out our [Discord](https://discord.com/invite/Zm99SKhhtA).`;
let token=process.env.GITHUB_TOKEN;
const octokit = github.getOctokit(token);
const isIssue = !!context.payload.issue;
let isFirstContribution;

if (isIssue) {
const query = `query($owner:String!, $name:String!, $contributer:String!) {
repository(owner:$owner, name:$name){
issues(first: 1, filterBy: {createdBy:$contributer}){
totalCount
}
}
}`;
const variables = {
owner: context.repo.owner,
name: context.repo.repo,
contributer: context.payload.sender.login
};
const { repository: { issues: { totalCount } } } = await octokit.graphql(query, variables);
isFirstContribution = totalCount === 1;
} else {
const query = `query($qstr: String!) {
search(query: $qstr, type: ISSUE, first: 1) {
issueCount
}
}`;
const variables = {
qstr: `repo:${context.repo.owner}/${context.repo.repo} type:pr author:${context.payload.sender.login}`,
};
const { search: { issueCount } } = await octokit.graphql(query, variables);
isFirstContribution = issueCount === 1;
}

if (!isFirstContribution) {
console.log(`Not the user's first contribution.`);
return;
}

const message = isIssue ? issueMessage : prMessage;

if (isIssue) {
const issueNumber = context.payload.issue.number;
await octokit.rest.issues.createComment({
owner: context.payload.repository.owner.login,
repo: context.payload.repository.name,
issue_number: issueNumber,
body: message
});
} else {
const pullNumber = context.payload.pull_request.number;
await octokit.rest.pulls.createReview({
owner: context.payload.repository.owner.login,
repo: context.payload.repository.name,
pull_number: pullNumber,
body: message,
event: 'COMMENT'
});
}
}

run().catch(err => core.setFailed(err.message));
33 changes: 33 additions & 0 deletions .github/workflows/welcome-first-time-contributor.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: Welcome first time contributors

on:
pull_request_target:
types:
- opened
issues:
types:
- opened

jobs:
welcome:
name: Post welcome message
runs-on: ubuntu-latest
strategy:
matrix:
node-version: [18.x]
steps:
- name: Checkout code
uses: actions/checkout@v2

- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v1
with:
node-version: ${{ matrix.node-version }}
- name: NPM Install
run: npm install

- name: Run welcome script
run: node .github/scripts/welcome-first-time-contributor.js
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Loading