Skip to content

Commit 774cbe5

Browse files
committed
Make permision write the default
Prevents unnecesery hickups with the role out by users
1 parent 5ff7e45 commit 774cbe5

1 file changed

Lines changed: 12 additions & 8 deletions

File tree

README.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@ To use this action, simply include it as a step in your workflow file. No inputs
99
````yaml
1010
name: My PublicCode Workflow
1111

12+
permissions:
13+
contents: write
14+
1215
on:
1316
push:
1417
branches:
@@ -24,13 +27,8 @@ jobs:
2427

2528
In the above example a `publiccode` file is updated every time code on the `main` branche is touched
2629

27-
> **Warning**
28-
> If you do not supply the action with an access token or an SSH key, you must access your repositories settings and provide `Read and Write Permissions` to the provided `GITHUB_TOKEN`, otherwise you'll potentially run into permission issues. Alternatively you can set the following in your workflow file to grant the action the permissions it needs.
29-
30-
```yml
31-
permissions:
32-
contents: write
33-
```
30+
> **Info**
31+
> Alternatively to setting the write permission for the workflow, you can also supply the action with an access token or an SSH key; see inputs for more details.
3432

3533
## Inputs
3634

@@ -48,6 +46,9 @@ example ussage of the inputs
4846
````yaml
4947
name: My PublicCode Workflow
5048

49+
permissions:
50+
contents: write
51+
5152
on:
5253
push:
5354
branches:
@@ -98,6 +99,9 @@ Need a quick way to present your project online but don't have the time te creat
9899
````yaml
99100
name: My PublicCode Workflow
100101

102+
permissions:
103+
contents: write
104+
101105
on:
102106
push:
103107
branches:
@@ -110,7 +114,7 @@ jobs:
110114
- name: Update publiccode.yaml
111115
uses: OpenCatalogi/publiccode-action@1.2.1
112116
- name: Deploy Product Github Page
113-
uses: OpenCatalogi/productpage-action@1
117+
uses: OpenCatalogi/productpage-action@1.0.0
114118
````
115119

116120
[Read more](https://github.com/marketplace/actions/create-an-product-page) about the product page action

0 commit comments

Comments
 (0)