Skip to content

Commit 0614132

Browse files
authoredAug 9, 2024··
Added API docs building to continuous integration. (#4)
Signed-off-by: Hermann Mayer <[email protected]>
1 parent 92119d1 commit 0614132

File tree

4 files changed

+7
-59
lines changed

4 files changed

+7
-59
lines changed
 

‎.github/workflows/documentation.yml

-40
This file was deleted.

‎.github/workflows/release.yml

+6
Original file line numberDiff line numberDiff line change
@@ -46,3 +46,9 @@ jobs:
4646

4747
- name: Push the release Git commit/tag and package to the registry
4848
run: make release
49+
50+
- name: Build and upload application documentation
51+
run: api-docs && coverage --docs-only
52+
env:
53+
WORKFLOW_DISPATCH_TOKEN: '${{ secrets.WORKFLOW_DISPATCH_TOKEN }}'
54+
GITHUB_TAG: 'v${{ github.event.inputs.VERSION }}'

‎.github/workflows/test.yml

-18
Original file line numberDiff line numberDiff line change
@@ -45,21 +45,3 @@ jobs:
4545

4646
- name: Upload the code coverage report
4747
run: coverage
48-
49-
trigger-docs:
50-
name: Trigger the documentation upload
51-
runs-on: ubuntu-22.04
52-
timeout-minutes: 2
53-
needs: test
54-
if: github.ref == 'refs/heads/master'
55-
steps:
56-
- name: Prepare the virtual environment
57-
uses: hausgold/actions/ci@master
58-
with:
59-
clone_token: '${{ secrets.CLONE_TOKEN }}'
60-
settings_secret_key: '${{ secrets.SETTINGS_SECRET_KEY }}'
61-
settings: '${{ github.repository }}'
62-
target: ci/noop
63-
64-
- name: Trigger the documentation upload
65-
run: workflow documentation

‎CHANGELOG.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
### next
22

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

55
### 1.3.0
66

0 commit comments

Comments
 (0)
Please sign in to comment.