Updated doc (#15) #67
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: Build Sphinx Docs | |
| on: | |
| push: | |
| branches: [main] | |
| pull_request: | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| jobs: | |
| docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: actions/setup-python@v4 | |
| with: | |
| python-version: '3.8' | |
| - name: Install Poetry | |
| run: curl -sSL https://install.python-poetry.org/ | python - | |
| - name: Add Poetry to PATH | |
| run: echo "$HOME/.poetry/bin" >> $GITHUB_PATH | |
| - name: Install dependencies | |
| run: poetry install | |
| - name: Validate STIX bundles | |
| run: poetry run python src/util/cli_validator.py | |
| - name: Build HTML docs | |
| run: poetry run make docs-ci | |
| - name: Copy Mappings Excel to Website | |
| run: mkdir docs/extra/xlsx && cp "mappings/input/enterprise/xlsx/Sensor to Data Source.xlsx" docs/extra/xlsx | |
| - name: Copy Mappings CSVs to Website | |
| run: mkdir docs/extra/csv && cp mappings/input/enterprise/csv/*.csv docs/extra/csv | |
| - name: Copy Navigator Layers to Website | |
| run: mkdir docs/extra/navigator && cp mappings/layers/enterprise/*.json docs/extra/navigator | |
| - name: Copy STIX Bundles to Website | |
| run: mkdir docs/extra/stix && cp mappings/stix/enterprise/*.json docs/extra/stix | |
| - name: Upload HTML docs | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: sensor-mappings-to-attack-docs-html | |
| path: docs/_build/dirhtml/ | |
| # # TODO Uncomment before publishing repository. | |
| # github_pages: | |
| # # This job only runs when committing or merging to main branch. | |
| # if: github.ref_name == 'main' | |
| # needs: docs | |
| # runs-on: ubuntu-latest | |
| # environment: | |
| # name: github-pages | |
| # url: $\{\{ steps.deployment.outputs.page_url \}\} | |
| # steps: | |
| # - name: Setup Pages | |
| # uses: actions/configure-pages@v2 | |
| # - name: Download HTML docs | |
| # uses: actions/download-artifact@v3 | |
| # with: | |
| # name: sensor-mappings-to-attack-docs-html | |
| # path: docs | |
| # - name: Upload artifact | |
| # uses: actions/upload-pages-artifact@v1 | |
| # with: | |
| # path: ./docs | |
| # - name: Deploy to GitHub Pages | |
| # id: deployment | |
| # uses: actions/deploy-pages@v1 |