-
Notifications
You must be signed in to change notification settings - Fork 75
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
ci: Pr label milestone check #2533
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,66 @@ | ||
const axios = require('axios'); | ||
|
||
const githubToken = process.env.GITHUB_TOKEN; | ||
const { GITHUB_REPOSITORY, GITHUB_PR_NUMBER } = process.env; | ||
|
||
const [owner, repo] = GITHUB_REPOSITORY.split('/'); | ||
|
||
async function getPRDetails() { | ||
const url = `https://api.github.com/repos/${owner}/${repo}/pulls/${GITHUB_PR_NUMBER}`; | ||
const response = await axios.get(url, { | ||
headers: { | ||
Authorization: `token ${githubToken}` | ||
} | ||
}); | ||
return response.data; | ||
} | ||
|
||
async function getIssueDetails(issueNumber) { | ||
const url = `https://api.github.com/repos/${owner}/${repo}/issues/${issueNumber}`; | ||
const response = await axios.get(url, { | ||
headers: { | ||
Authorization: `token ${githubToken}` | ||
} | ||
}); | ||
return response.data; | ||
} | ||
|
||
async function run() { | ||
try { | ||
const pr = await getPRDetails(); | ||
const { labels: prLabels, milestone: prMilestone, body: prBody } = pr; | ||
|
||
if (prLabels.length === 0) { | ||
throw new Error('The PR has no labels.'); | ||
} | ||
if (!prMilestone) { | ||
throw new Error('The PR has no milestone.'); | ||
} | ||
|
||
const issueNumberMatches = prBody.match(/#(\d+)/g); | ||
|
||
if (!issueNumberMatches) { | ||
console.log('No associated issues found in PR description.'); | ||
} else { | ||
for (const match of issueNumberMatches) { | ||
const issueNumber = match.replace('#', ''); | ||
const issue = await getIssueDetails(issueNumber); | ||
const { labels: issueLabels, milestone: issueMilestone } = issue; | ||
|
||
if (issueLabels.length === 0) { | ||
throw new Error(`Associated issue #${issueNumber} has no labels.`); | ||
} | ||
if (!issueMilestone) { | ||
throw new Error(`Associated issue #${issueNumber} has no milestone.`); | ||
} | ||
} | ||
} | ||
|
||
console.log('PR and all associated issues have labels and milestones.'); | ||
} catch (error) { | ||
console.error(error.message); | ||
process.exit(1); | ||
} | ||
} | ||
|
||
run(); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
name: PR Label and Milestone Check | ||
|
||
on: | ||
pull_request: | ||
types: [opened, edited, labeled, unlabeled, synchronize] | ||
|
||
jobs: | ||
check_pr: | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- name: Checkout code | ||
uses: actions/checkout@v2 | ||
|
||
- name: Set up Node.js | ||
uses: actions/setup-node@v3 | ||
with: | ||
node-version: '18' | ||
|
||
- name: Install dependencies | ||
run: npm install axios | ||
|
||
- name: Check PR labels and milestones | ||
env: | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
GITHUB_PR_NUMBER: ${{ github.event.number }} | ||
run: node .github/scripts/check-pr.js |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Nana-EC before merging, I want to confirm with you that both the issue(s) and the PR, need to have labels and milestones set.
Also, if there are no issue related, no problem, this is to allow PRs opened by Snyks and dependabot, as well as some cherry-picks and other PRs that usually don't have related issues.