Skip to content

Commit

Permalink
Added API docs building to continuous integration.
Browse files Browse the repository at this point in the history
Signed-off-by: Hermann Mayer <hermann.mayer92@gmail.com>
  • Loading branch information
Jack12816 committed Aug 9, 2024
1 parent 6bbb601 commit cb54a0c
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 59 deletions.
40 changes: 0 additions & 40 deletions .github/workflows/documentation.yml

This file was deleted.

6 changes: 6 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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 }}'
18 changes: 0 additions & 18 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,21 +42,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
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
### next

* TODO: Replace this bullet point with an actual description of a change.
* Added API docs building to continuous integration (#25)

### 1.2.0

Expand Down

0 comments on commit cb54a0c

Please sign in to comment.