Skip to content

Commit

Permalink
Add a note about "Publish release" workflow required permissions
Browse files Browse the repository at this point in the history
  • Loading branch information
cedric-anne committed Feb 16, 2024
1 parent 9917c20 commit 2920a0f
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,10 @@ This workflow will publish a release corresponding to the given tag.

You can use this workflow using the following Github Actions configuration.
The only requirement is the presence of the `glpi-project/tools` in the composer (dev) dependencies of the plugin.
This workflow will require the `contents: "write"` permission to be able to create a release.

```yaml
name: "Plugin release"
name: "Publish release"

on:
push:
Expand All @@ -17,6 +18,8 @@ on:

jobs:
publish-release:
permissions:
contents: "write"
name: "Publish release"
uses: "glpi-project/plugin-release-workflows/.github/workflows/publish-release.yml@v1"
with:
Expand Down

0 comments on commit 2920a0f

Please sign in to comment.