From 4646ff76ae041cdb85bfa8fd12ffc366669fb982 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Fichot?= Date: Fri, 29 Dec 2023 09:44:47 +0100 Subject: [PATCH] docs: Update README with link to demo --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 825bdd6..64b4cab 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,8 @@ This GitHub Action, designed to complement the [Generate Structurizr Diagrams Images from DSL](https://github.com/marketplace/actions/generate-structurizr-diagrams-images-from-dsl) action, automatically comments on pull requests with the previously generated Structurizr diagrams. It ensures that team members can easily review the latest architecture diagrams directly within the context of a PR. +-> [See this PR for a demo](https://github.com/sebastienfi/structurizr-github-actions-demo/pull/2). + ## Prerequisites To use this action effectively, you should have: @@ -31,6 +33,10 @@ jobs: comment-on-pr: if: github.event.workflow_run.conclusion == 'success' runs-on: ubuntu-latest + permissions: + contents: read # Allow to work with the contents of the repository, including git pull. + issues: write # Allow to comment on pull requests. + pull-requests: write # Allow to list and create pr's comments. steps: - uses: sebastienfi/structurizr-pr-comment@v1 with: