zhengbangbo / update-repository-description

Github action for update description on repository.

Update Repository Description

Usage

• Example

uses: zhengbangbo/update-repository-description@v1.0.0
with:
  repo-token: ${{ secrets.MY_TOKEN }}

Note

This job failed due to the following 3 points:

1. The default permissions granted to GITHUB_TOKEN.
2. The workflows have read permissions in the repository for the contents and packages scopes only by default, which means to be restricted.
3. The related REST API belongs to the administration scope.

Summarized above, there are 3 ways to set the repo-token:

1. Select workflow permissions settings of a repo to the Read and write permissions option.
2. Generate a fine-grained personal access token with:
   1. All repositionries of repository access.
   2. Read and write access to Adminstration of repository permissions.
3. Edit the ci.yml with permissions.contents: write. related.

License

MIT