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.

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

add github actions bot with a hint comment for contributors. #147

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
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
33 changes: 33 additions & 0 deletions .github/workflows/hint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: Hint to a github contributor

on:
pull_request_target:
types: [opened, created]

jobs:
comment:
runs-on: ubuntu-latest
Copy link

Choose a reason for hiding this comment

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

Suggested change
runs-on: ubuntu-latest
runs-on: ubuntu-latest
permissions:
contents: write

https://docs.github.com/en/rest/issues/issues?apiVersion=2022-11-28#create-an-issue

The fine-grained token must have the following permission set:

"Issues" repository permissions (write)

Default permissions for repositories depend on when the repository/user/organization/enterprise was created. Newer organizations are created with more restrictive permissions. Older entities should be upgraded to restricted permissions, but until they are, you'll be able to do things w/o declaring permissions and will experience problems trying to share those workflows to restricted containers.

https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#configuring-the-default-github_token-permissions

steps:
- name: Add comment to PR
env:
URL: ${{ github.event.pull_request.comments_url }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
Copy link

Choose a reason for hiding this comment

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

Suggested change
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GH_TOKEN: ${{ github.token }}

MESSAGE:
Hi!\n
Thanks for the patch.\n
Please take a look at
https://github.com/ovn-org/ovn/blob/main/Documentation/internals/contributing/submitting-patches.rst
and
https://github.com/ovn-org/ovn/blob/main/Documentation/internals/contributing/coding-style.rst\n
Squash commits and ensure that your patch passes the checks:\n
```\n
$ ./utilities/checkpatch.py -1\n
```\n

run: |
curl \
Copy link

Choose a reason for hiding this comment

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

You're using curl, but this could really be done using gh api instead.

-X POST \
$URL \
-H "Content-Type: application/json" \
-H "Authorization: token $GITHUB_TOKEN" \
Copy link

Choose a reason for hiding this comment

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

Suggested change
-H "Authorization: token $GITHUB_TOKEN" \
-H "Authorization: token $GH_TOKEN" \

--data "{ \"body\": \"$MESSAGE\" }"
1 change: 1 addition & 0 deletions Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,7 @@ EXTRA_DIST = \
.ci/osx-build.sh \
.ci/osx-prepare.sh \
.ci/ovn-kubernetes/Dockerfile \
.github/workflows/hint.yml \
.github/workflows/test.yml \
.github/workflows/ovn-kubernetes.yml \
boot.sh \
Expand Down