Skip to content

Commit

Permalink
doc: fix rendering of markdown notes
Browse files Browse the repository at this point in the history
  • Loading branch information
jamacku committed Nov 9, 2023
1 parent 82df019 commit 90e0304
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,9 @@ To setup Development freeze, we need three files:
* Workflow that runs on `workflow-run` trigger, downloads artifact and runs `devel_freezer` GitHub Action
* `development-freeze` configuration

<!-- markdownlint-disable MD013 -->
> **Note**: Setup is complicated due to GitHub [permissions on `GITHUB_TOKEN`](https://docs.github.com/en/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token). When used in workflow executed from fork it has `read-only` permissions. By using `workflow-run` trigger we are able to [safely overcome this limitation](https://securitylab.github.com/research/github-actions-preventing-pwn-requests/) and it allow us to comment on Pull Requests.
> **Note**
>
> Setup is complicated due to GitHub [permissions on `GITHUB_TOKEN`](https://docs.github.com/en/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token). When used in workflow executed from fork it has `read-only` permissions. By using `workflow-run` trigger we are able to [safely overcome this limitation](https://securitylab.github.com/research/github-actions-preventing-pwn-requests/) and it allow us to comment on Pull Requests.
```yml
name: Gather Pull Request Metadata
Expand Down Expand Up @@ -160,7 +161,9 @@ jobs:
token: ${{ secrets.GITHUB_TOKEN }}
```
> **Note**: `fetch-depth: 0` is required in order to have access to full history including tags.
> **Note**
>
> `fetch-depth: 0` is required in order to have access to full history including tags.

```yml
policy:
Expand Down

0 comments on commit 90e0304

Please sign in to comment.