Add doxygen docs comments #79
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: "Release EQL" | |
| on: | |
| release: | |
| types: | |
| - published | |
| pull_request: # runs everything but the last step | |
| branches: | |
| - main | |
| paths: | |
| - .github/workflows/release-eql.yml | |
| # Useful for debugging | |
| workflow_dispatch: | |
| defaults: | |
| run: | |
| shell: bash -l {0} | |
| permissions: | |
| contents: write | |
| jobs: | |
| build-and-publish: | |
| runs-on: ubuntu-latest | |
| name: Build EQL | |
| if: ${{ github.event_name != 'release' || contains(github.event.release.tag_name, 'eql') }} | |
| timeout-minutes: 5 | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: jdx/mise-action@v2 | |
| with: | |
| version: 2025.1.6 # [default: latest] mise version to install | |
| install: true # [default: true] run `mise install` | |
| cache: true # [default: true] cache mise using GitHub's cache | |
| - name: Build EQL release | |
| run: | | |
| mise run build --version ${{github.event.release.tag_name}} | |
| - name: Upload EQL artifacts | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: eql-release | |
| path: | | |
| release/cipherstash-encrypt.sql | |
| release/cipherstash-encrypt-uninstall.sql | |
| - name: Publish EQL release artifacts | |
| uses: softprops/action-gh-release@v2 | |
| if: startsWith(github.ref, 'refs/tags/') | |
| with: | |
| files: | | |
| release/cipherstash-encrypt.sql | |
| release/cipherstash-encrypt-uninstall.sql | |
| release/cipherstash-encrypt-supabase.sql | |
| release/cipherstash-encrypt-uninstall-supabase.sql | |
| - name: Notify Multitudes | |
| if: github.event_name == 'release' | |
| run: | | |
| curl --request POST \ | |
| --fail-with-body \ | |
| --url "https://api.developer.multitudes.co/deployments" \ | |
| --header "Content-Type: application/json" \ | |
| --header "Authorization: ${{ secrets.MULTITUDES_ACCESS_TOKEN }}" \ | |
| --data '{"commitSha": "${{ github.sha }}", "environmentName":"production"}' | |
| publish-docs: | |
| runs-on: ubuntu-latest | |
| name: Build and Publish Documentation | |
| if: ${{ github.event_name != 'release' || contains(github.event.release.tag_name, 'eql') }} | |
| timeout-minutes: 10 | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: jdx/mise-action@v2 | |
| with: | |
| version: 2025.1.6 # [default: latest] mise version to install | |
| install: true # [default: true] run `mise install` | |
| cache: true # [default: true] cache mise using GitHub's cache | |
| - name: Install Doxygen | |
| run: | | |
| sudo apt-get update | |
| sudo apt-get install -y doxygen | |
| - name: Validate documentation | |
| run: | | |
| mise run docs:validate | |
| - name: Generate documentation | |
| run: | | |
| mise run docs:generate | |
| - name: Package documentation | |
| run: | | |
| mise run docs-package ${{ github.event.release.tag_name }} | |
| - name: Upload documentation artifacts | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: eql-docs | |
| path: | | |
| release/eql-docs-*.zip | |
| release/eql-docs-*.tar.gz | |
| - name: Publish documentation to release | |
| uses: softprops/action-gh-release@v2 | |
| if: startsWith(github.ref, 'refs/tags/') | |
| with: | |
| files: | | |
| release/eql-docs-*.zip | |
| release/eql-docs-*.tar.gz |