From c8098da66abbf3bffc4e7f1479230637fed9472e Mon Sep 17 00:00:00 2001 From: Andre <200930841+Andre-Bzk@users.noreply.github.com> Date: Sat, 8 Aug 2026 12:56:06 +0200 Subject: [PATCH] docs: deploy diagrams with GitHub Pages Repository links expose the generated HTML as source instead of an interactive diagram. Publishing the docs directory through Pages gives readers a rendered target while keeping non-documentation files out of the public site artifact. --- .github/workflows/pages.yml | 41 +++++++++++++++++++++++++++++++++++++ README.md | 8 ++++---- 2 files changed, 45 insertions(+), 4 deletions(-) create mode 100644 .github/workflows/pages.yml diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml new file mode 100644 index 0000000..9e36209 --- /dev/null +++ b/.github/workflows/pages.yml @@ -0,0 +1,41 @@ +name: Deploy GitHub Pages + +on: + push: + branches: + - main + paths: + - docs/** + - .github/workflows/pages.yml + workflow_dispatch: + +permissions: + contents: read + pages: write + id-token: write + +concurrency: + group: pages + cancel-in-progress: false + +jobs: + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v6 + + - name: Setup Pages + uses: actions/configure-pages@v5 + + - name: Upload artifact + uses: actions/upload-pages-artifact@v4 + with: + path: docs + + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 diff --git a/README.md b/README.md index 236e8a2..fbfaa5e 100644 --- a/README.md +++ b/README.md @@ -26,8 +26,8 @@ Keeping the repositories' *git content* up to date remains Gitea's job. ### Architecture -- [Architecture diagram](docs/architecture/sync_mirrors.architecture.html) -- [Sequence diagram](docs/architecture/sync_mirrors.sequence.html) +- [Architecture diagram](https://andre-bzk.github.io/github-to-gitea-mirror/architecture/sync_mirrors.architecture.html) +- [Sequence diagram](https://andre-bzk.github.io/github-to-gitea-mirror/architecture/sync_mirrors.sequence.html) ### Requirements @@ -241,8 +241,8 @@ bleibt Giteas Aufgabe. ### Architektur -- [Architecture-Diagramm](docs/architecture/sync_mirrors.architecture.html) -- [Sequence-Diagramm](docs/architecture/sync_mirrors.sequence.html) +- [Architecture-Diagramm](https://andre-bzk.github.io/github-to-gitea-mirror/architecture/sync_mirrors.architecture.html) +- [Sequence-Diagramm](https://andre-bzk.github.io/github-to-gitea-mirror/architecture/sync_mirrors.sequence.html) ### Voraussetzungen