ci: add permissions to the release workflow

agoralabs-sh · Sep 11, 2024 · 051ddb6 · 051ddb6
1 parent 7aff9d4
commit 051ddb6
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -27,6 +27,10 @@ jobs:
   release:
     name: "Release"
     needs: install
+    permissions:
+      contents: write # to be able to publish a github release
+      issues: write # to be able to comment on released issues
+      pull-requests: write # to be able to comment on released pull requests
     runs-on: ubuntu-latest
     steps:
       - name: "🛎 Checkout"

diff --git a/README.md b/README.md
@@ -111,6 +111,7 @@ This will compile the Typescript source code into a `dist/` directory.
 | `yarn run lint`       | Runs the linter on `.js` and `.ts` files.                                          |
 | `yarn run prettier`   | Runs the prettier on `.js` and `.ts` files.                                        |
 | `yarn test`           | Runs the tests.                                                                    |
+| `yarn types:check`    | Performs a type check on the `src/` directory.                                     |
 
 <sup>[Back to top ^][table-of-contents]</sup>