doc(cli): add bite bugzilla user get examples
#155
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: doc | |
| on: | |
| push: | |
| branches: ['**'] | |
| paths: | |
| - "crates/*/doc/**" | |
| - "doc/**" | |
| - ".github/workflows/doc.yml" | |
| pull_request: | |
| branches: [main] | |
| paths: | |
| - "crates/*/doc/**" | |
| - "doc/**" | |
| workflow_dispatch: | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| container: | |
| image: asciidoctor/docker-asciidoctor | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3 | |
| - name: Build docs | |
| run: | | |
| make -C doc | |
| # notify github this isn't a jekyll site | |
| touch target/doc/cli/html/.nojekyll | |
| # upload-pages-artifact doesn't work with busybox tar provided by the container | |
| - name: Install GNU tar | |
| if: ${{ github.ref_name == 'main' && github.repository == 'radhermit/bugbite' }} | |
| run: apk add tar | |
| - name: Upload artifact | |
| if: ${{ github.ref_name == 'main' && github.repository == 'radhermit/bugbite' }} | |
| uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 #v5.0.0 | |
| with: | |
| path: target/doc/cli/html | |
| deploy: | |
| if: ${{ github.ref_name == 'main' && github.repository == 'radhermit/bugbite' }} | |
| needs: build | |
| runs-on: ubuntu-latest | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| permissions: | |
| pages: write | |
| id-token: write | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@cd2ce8fcbc39b97be8ca5fce6e763baed58fa128 #v5.0.0 |