Skip to content

Commit

Permalink
docs: Update README with link to demo
Browse files Browse the repository at this point in the history
  • Loading branch information
sebastienfi committed Dec 29, 2023
1 parent fae0e24 commit 4646ff7
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down

0 comments on commit 4646ff7

Please sign in to comment.