docs(bindings): add example for kms pkey offload #9656
Workflow file for this run
This file contains 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: s2n-tls Documentation | |
on: | |
push: | |
branches: [main] | |
pull_request: | |
branches: [main] | |
merge_group: | |
types: [checks_requested] | |
branches: [main] | |
jobs: | |
generate-doxygen: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout repo | |
uses: actions/checkout@v4 | |
- name: Create Documentation | |
run: | | |
.github/s2n_doxygen.sh | |
- name: Upload documentation to action | |
# Upload the doxygen artifacts on pull requests to help reviewers easily | |
# view changes. | |
if: ${{ github.event_name == 'pull_request' }} | |
uses: actions/upload-artifact@v4 | |
with: | |
name: s2n-tls-doxygen | |
path: | | |
docs/doxygen/output | |
- name: Deploy documentation to gh-pages | |
uses: peaceiris/actions-gh-pages@v4 | |
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }} | |
with: | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
destination_dir: ./doxygen | |
publish_dir: ./docs/doxygen/output/html | |