From 6989bb2e2c87fa00d49f816bfa06c48d68135dfd Mon Sep 17 00:00:00 2001 From: Hermann Mayer Date: Fri, 9 Aug 2024 15:51:02 +0200 Subject: [PATCH] Added API docs building to continuous integration. (#9) Signed-off-by: Hermann Mayer --- .github/workflows/documentation.yml | 40 ----------------------------- .github/workflows/release.yml | 6 +++++ .github/workflows/test.yml | 18 ------------- CHANGELOG.md | 2 +- 4 files changed, 7 insertions(+), 59 deletions(-) delete mode 100644 .github/workflows/documentation.yml diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml deleted file mode 100644 index 8894b15..0000000 --- a/.github/workflows/documentation.yml +++ /dev/null @@ -1,40 +0,0 @@ -name: Build Documentation -on: - repository_dispatch: - types: [documentation] - -concurrency: - group: 'docs' - -jobs: - docs: - name: Build gem documentation - runs-on: ubuntu-22.04 - timeout-minutes: 5 - steps: - - uses: actions/checkout@v4 - - - name: Install the correct Ruby version - uses: ruby/setup-ruby@v1 - with: - ruby-version: 2.7 - bundler-cache: true - rubygems: '3.4.22' - - - name: Prepare the virtual environment - uses: hausgold/actions/ci@master - with: - clone_token: '${{ secrets.CLONE_TOKEN }}' - settings_secret_key: '${{ secrets.SETTINGS_SECRET_KEY }}' - settings: '${{ github.repository }}' - target: ci/gem-test - - - name: Build gem documentation - run: make docs - - - name: Upload the code coverage report - run: coverage - - - name: Add this job to the commit status - run: commit-status '${{ job.status }}' - if: always() diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 363bb30..f6d3ea8 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -46,3 +46,9 @@ jobs: - name: Push the release Git commit/tag and package to the registry run: make release + + - name: Build and upload application documentation + run: api-docs && coverage --docs-only + env: + WORKFLOW_DISPATCH_TOKEN: '${{ secrets.WORKFLOW_DISPATCH_TOKEN }}' + GITHUB_TAG: 'v${{ github.event.inputs.VERSION }}' diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index bfa13e7..1c1fedb 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -54,21 +54,3 @@ jobs: - name: Upload the code coverage report run: coverage - - trigger-docs: - name: Trigger the documentation upload - runs-on: ubuntu-22.04 - timeout-minutes: 2 - needs: test - if: github.ref == 'refs/heads/master' - steps: - - name: Prepare the virtual environment - uses: hausgold/actions/ci@master - with: - clone_token: '${{ secrets.CLONE_TOKEN }}' - settings_secret_key: '${{ secrets.SETTINGS_SECRET_KEY }}' - settings: '${{ github.repository }}' - target: ci/noop - - - name: Trigger the documentation upload - run: workflow documentation diff --git a/CHANGELOG.md b/CHANGELOG.md index 03afd6d..e15612a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,6 @@ ### next -* TODO: Replace this bullet point with an actual description of a change. +* Added API docs building to continuous integration (#9) ### 1.2.0