Skip to content

Commit 47114f7

Browse files
committed
ci: add documentation publishing to release workflow
1 parent bcbb8c2 commit 47114f7

File tree

1 file changed

+48
-0
lines changed

1 file changed

+48
-0
lines changed

.github/workflows/release-eql.yml

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,3 +66,51 @@ jobs:
6666
--header "Content-Type: application/json" \
6767
--header "Authorization: ${{ secrets.MULTITUDES_ACCESS_TOKEN }}" \
6868
--data '{"commitSha": "${{ github.sha }}", "environmentName":"production"}'
69+
70+
publish-docs:
71+
runs-on: ubuntu-latest
72+
name: Build and Publish Documentation
73+
if: ${{ github.event_name != 'release' || contains(github.event.release.tag_name, 'eql') }}
74+
timeout-minutes: 10
75+
76+
steps:
77+
- uses: actions/checkout@v4
78+
79+
- uses: jdx/mise-action@v2
80+
with:
81+
version: 2025.1.6 # [default: latest] mise version to install
82+
install: true # [default: true] run `mise install`
83+
cache: true # [default: true] cache mise using GitHub's cache
84+
85+
- name: Install Doxygen
86+
run: |
87+
sudo apt-get update
88+
sudo apt-get install -y doxygen
89+
90+
- name: Validate documentation
91+
run: |
92+
mise run docs:validate
93+
94+
- name: Generate documentation
95+
run: |
96+
mise run docs:generate
97+
98+
- name: Package documentation
99+
run: |
100+
mise run docs:package -- ${{ github.event.release.tag_name }}
101+
102+
- name: Upload documentation artifacts
103+
uses: actions/upload-artifact@v4
104+
with:
105+
name: eql-docs
106+
path: |
107+
release/eql-docs-*.zip
108+
release/eql-docs-*.tar.gz
109+
110+
- name: Publish documentation to release
111+
uses: softprops/action-gh-release@v2
112+
if: startsWith(github.ref, 'refs/tags/')
113+
with:
114+
files: |
115+
release/eql-docs-*.zip
116+
release/eql-docs-*.tar.gz

0 commit comments

Comments
 (0)