diff --git a/.github/workflows/master.yml b/.github/workflows/master.yml index 3d0e692..93e4b65 100644 --- a/.github/workflows/master.yml +++ b/.github/workflows/master.yml @@ -1,8 +1,10 @@ -name: master build +name: Build (master) on: push: branches: [ "master" ] + tags-ignore: + - '**' pull_request: branches: [ "master" ] @@ -21,11 +23,64 @@ jobs: run: sudo apt-get -y install graphviz - name: Build with Maven run: mvn -B package --file pom.xml - - name: Upload Architecture Documentation - uses: actions/upload-artifact@v3 + - uses: actions/cache@v2 + id: target-cache with: - name: arc42-doc - path: | - target/generated-docs/ddd-cm-sample-architecture.pdf + path: ./target/* + key: ${{ github.sha }} - name: Upload coverage to Codecov uses: codecov/codecov-action@v1 + + upload_arc42_pdf: + name: Upload Architecture Documentation (PDF) + runs-on: ubuntu-latest + needs: [ build ] + steps: + - uses: actions/cache@v2 + id: target-cache + with: + path: ./target/* + key: ${{ github.sha }} + - name: Upload Architecture Documentation + uses: actions/upload-artifact@v3 + with: + name: arc42-doc + path: | + target/generated-docs/architecture.pdf + + publish_gh_page: + name: Publish GH Page + runs-on: ubuntu-latest + needs: [ build ] + permissions: + contents: read + pages: write + id-token: write + concurrency: + group: "pages" + cancel-in-progress: false + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + steps: + - uses: actions/cache@v2 + id: target-cache + with: + path: ./target/* + key: ${{ github.sha }} + - name: Setup Pages + uses: actions/configure-pages@v3 + - uses: baileyjm02/markdown-to-pdf@v1 + with: + input_dir: docs + output_dir: target/generated-docs + build_html: true + build_pdf: false + - name: Upload artifact + uses: actions/upload-pages-artifact@v2 + with: + path: './target/generated-docs' + if-no-files-found: error + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v2 diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..ec5b72b --- /dev/null +++ b/docs/README.md @@ -0,0 +1,5 @@ +![Context Mapper](https://raw.githubusercontent.com/wiki/ContextMapper/context-mapper-dsl/logo/cm-logo-github-small.png) +# Context Mapper: Three Letter Abbreviation (TLA) Sample App - Documentation + + * [Arc42 Documentation (Website)](https://contextmapper.org/ddd-cm-tla-sample-application/architecture.html) + * [Arc42 Documentation (PDF)](https://contextmapper.org/ddd-cm-tla-sample-application/architecture.pdf) diff --git a/docs/architecture/ddd-cm-sample-architecture.adoc b/docs/architecture/architecture.adoc similarity index 100% rename from docs/architecture/ddd-cm-sample-architecture.adoc rename to docs/architecture/architecture.adoc