Skip to content

Commit d6a2efd

Browse files
committed
adds info about workflow permissions
1 parent fb0c359 commit d6a2efd

1 file changed

Lines changed: 24 additions & 8 deletions

File tree

docs/trusted-build-systems/github.md

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,6 @@ description: GitHub
1313
* link it to each SignPath Project for GitHub
1414
* Required for [source code and build policies](#define-policies-for-source-code-and-builds): Install the [SignPath GitHub App](https://github.com/apps/signpath) and allow access to the code repositories.
1515

16-
{:.panel.info}
17-
> **ZIP archives**
18-
>
19-
> By default, the `upload-artifact` action creates a ZIP archive, which requires the root element of your [Artifact Configurations](/artifact-configuration) to be of type `<zip-file>`.
20-
> If you want to specify your artifact type directly, specify `archive: false` in the `upload-artifact` action. See [Usage](#usage).
21-
>
22-
> <i class='la la-exclamation-triangle'></i> Note that there is an open bug in GitHub's `upload-artifact` action where the `name` parameter is ignored and the action fails if another artifact with the same filename has already been uploaded. See issues [#769](https://github.com/actions/upload-artifact/issues/769) and [#785](https://github.com/actions/upload-artifact/issues/785).
23-
2416
{:.panel.info}
2517
> **GitHub Enterprise Server**
2618
>
@@ -65,6 +57,30 @@ steps:
6557
```
6658
{% endraw %}
6759
60+
{:.panel.info}
61+
> **ZIP archives**
62+
>
63+
> By default, the `upload-artifact` action creates a ZIP archive, which requires the root element of your [Artifact Configurations](/artifact-configuration) to be of type `<zip-file>`.
64+
> If you want to specify your artifact type directly, specify `archive: false` in the `upload-artifact` action. See [Usage](#usage).
65+
>
66+
> <i class='la la-exclamation-triangle'></i> Note that there is an open bug in GitHub's `upload-artifact` action where the `name` parameter is ignored and the action fails if another artifact with the same filename has already been uploaded. See issues [#769](https://github.com/actions/upload-artifact/issues/769) and [#785](https://github.com/actions/upload-artifact/issues/785).
67+
68+
{:.panel.info}
69+
> **Workflow permissions**
70+
>
71+
> If _all_ of the following conditions apply, the required permissions have to be enabled in the workflow definition:
72+
>
73+
> * the the GitHub repository is private
74+
> * the workflow permissions are set to the default "Read repository contents and packages permissions"
75+
> * The SignPath GitHub App is _not_ installed
76+
>
77+
> You can use the following snippet:
78+
> ```
79+
> permissions:
80+
> actions: read
81+
> contents: read
82+
> ```
83+
6884
### Action input parameters
6985

7086
{% raw %}

0 commit comments

Comments
 (0)