Skip to content

Support custom permissions #3

Closed

Description

@parkerbxyz

follow up to: 2d5eced

Our idea is to add separate permission_* parameters for each permission supported by GitHub Apps:
https://docs.github.com/en/rest/overview/permissions-required-for-github-apps

The permission_* keys can be generated based off https://github.com/octokit/app-permissions. Each time a new version of @octokit/app-permissions is released, the action.yml could be updated, in order to keep permissions always up-to-date. The README.md should be updated as well to make sure the documentation is up-to-date as well. Most permissions can be set to read or write, some can also be set to admin.

Having separate permissions has the benefit of code intelligence and errors shown directly on GitHub when an unknown permission is set due to a typo.

Activity

  1. gr2m commented on Nov 1, 2023

    @gr2m
    Contributor

    @octokit/app-permissions has a new release that I've been waiting for, it fixes a lot of incorrect and missing permissions: https://github.com/octokit/app-permissions/releases/tag/v2.0.0.

  2. rvermeulen commented on Oct 4, 2024

    @rvermeulen

    @parkerbxyz @gr2m is still being worked on?

  3. gr2m commented on Oct 7, 2024

    @gr2m
    Contributor

    yes, we just don't have much time for it and had to prioritize #143.

    We started to work on a script that auto-updates the action.yml file to add all supported permissions as separate input variables, so that you get the full benefit of type checking in your dev environment and on github.com:
    #168

  4. added this to the v2 milestone on Mar 20, 2025
  5. create-app-token-action-releaser commented on Mar 27, 2025

    @create-app-token-action-releaser
    Contributor

    🎉 This issue has been resolved in version 1.12.0 🎉

    The release is available on GitHub release

    Your semantic-release bot 📦🚀

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

      Milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions