Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Remove pull request template #18104

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
+30 −15
Open

Remove pull request template #18104

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d8a975c
Remove pull request template
aeisenberg Nov 25, 2024
d1b8556
Rename workflow
aeisenberg Nov 25, 2024
8512644
Extract reminders to a separate file
aeisenberg Nov 25, 2024
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
7 changes: 7 additions & 0 deletions .github/pr-comment-reminder.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
### Pull Request reminders for autofix

(internal access required)

- [ ] Autofixes generated based on these changes are valid, only needed if this PR makes significant changes to `.ql`, `.qll`, or `.qhelp` files. See [the documentation](https://github.com/github/codeql-team/blob/main/docs/best-practices/validating-autofix-for-query-changes.md).
- [ ] Changes to autofix are validated [at scale](https://github.com/github/codeql-dca/blob/main/doc/autofix.md).
- [ ] Adding a new query? Consider also [adding the query to autofix](https://github.com/github/codeml-autofix/blob/main/docs/updating-query-support.md#adding-a-new-query-to-the-query-suite).
14 changes: 0 additions & 14 deletions .github/pull_request_template.md
View file
Open in desktop

This file was deleted.

24 changes: 23 additions & 1 deletion .github/workflows/check-change-note.yml → ...flows/check-change-note-and-reminders.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Check change note
name: Check change note and reminders

permissions:
pull-requests: read
Expand All @@ -9,17 +9,39 @@ on:
paths:
- "*/ql/src/**/*.ql"
- "*/ql/src/**/*.qll"
- "*/ql/src/**/*.qhelp"
- "*/ql/lib/**/*.ql"
- "*/ql/lib/**/*.qll"
- "*/ql/lib/**/*.qhelp"
- "*/ql/lib/**/*.yml"
- "shared/**/*.ql"
- "shared/**/*.qll"
- "shared/**/*.qhelp"
- "!**/experimental/**"
- "!ql/**"
- "!rust/**"
- ".github/workflows/check-change-note.yml"

jobs:
add-pr-reminders:
env:
REPO: ${{ github.repository }}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
REPO: ${{ github.repository }}

https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/store-information-in-variables#default-environment-variables
explains GITHUB_REPOSITORY as

The owner and repository name. For example, octocat/Hello-World.

So we can skip declaring our own variable here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was just following along with REPO elsewhere in the file. Looking in history, I see that REPO was added 13 months ago...by you. 😄

https://github.com/github/codeql/pull/14542/files#diff-b2dac1c5458a76f5ad8257a642aeac9ecf2c1b44ee9ca36b62f4d49d8ff24f05R19

Is there a reason to change it in this job, but not the other?

PULL_REQUEST_NUMBER: ${{ github.event.number }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
runs-on: ubuntu-latest
steps:

- name: Check if the 'reminders' comment exists
run: |
reminder_comment=$(gh api "repos/$REPO/issues/$PULL_REQUEST_NUMBER/comments" --jq '.[] | select(.body | test("### Pull Request reminders for autofix"))')
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
reminder_comment=$(gh api "repos/$REPO/issues/$PULL_REQUEST_NUMBER/comments" --jq '.[] | select(.body | test("### Pull Request reminders for autofix"))')
reminder_comment=$(gh api "repos/$GITHUB_REPOSITORY/issues/$PULL_REQUEST_NUMBER/comments" --jq '.[] | select(.body | test("### Pull Request reminders for autofix"))')

if [ -z "$reminder_comment" ]; then
echo "The reminder comment does not exist. Adding it."
comment_body="$(cat .github/pr-comment-reminder.md)"
gh api "repos/$REPO/issues/$PULL_REQUEST_NUMBER/comments" -f body="$comment_body"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
gh api "repos/$REPO/issues/$PULL_REQUEST_NUMBER/comments" -f body="$comment_body"
gh api "repos/$GITHUB_REPOSITORY/issues/$PULL_REQUEST_NUMBER/comments" -f body="$comment_body"

fi
check-change-note:
env:
REPO: ${{ github.repository }}
Expand Down
Loading