Skip to content

docs: add github action permissions on README #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.

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
Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add github action permissions on README #75

wants to merge 1 commit into from

Conversation

aj3sh
Copy link
Member

@aj3sh aj3sh commented Aug 24, 2025

Description

Add GitHub action permissions on README

Related Issue

Closes #71

Type of Change

Please mark the appropriate option below to describe the type of change your pull request introduces:

  • Bug fix
  • New feature
  • Enhancement
  • Documentation update
  • Refactor
  • Other (please specify)

Checklist

  • My pull request has a clear title and description.
  • I have used semantic commit messages.
    Examples: "fix: Fixed foobar bug", "feat(accounts): Added foobar feature".
  • I have added/updated the necessary documentation on README.md.
  • I have added appropriate test cases (if applicable) to ensure the changes are functioning correctly.

Additional Notes

[Add any additional notes or context that you think the reviewers should know about.]

By submitting this pull request, I confirm that I have read and complied with the contribution guidelines of this project.

@aj3sh aj3sh requested a review from sugat009 August 24, 2025 06:03
@kosratdev
Copy link

@aj3sh Thanks for the update. I used it in the job level permission with only pull-requests: read. It works as expected.

  commitlint:
    runs-on: ubuntu-latest
    name: Conventional Commitlint
    permissions:
      pull-requests: read
    steps:
      - name: Conventional Commitlint
        uses: opensource-nepal/commitlint@v1

If we used it in the workflow level permission, we need both contents: read and pull-requests: read because we may have other jobs that require checkout, which uses the contents: read permission. However, at the job level, we only need pull-requests: read.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sugat009 sugat009 Awaiting requested review from sugat009

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

GitHub API failed with status code 403
2 participants
@aj3sh @kosratdev