-
Notifications
You must be signed in to change notification settings - Fork 561
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1613 from blacklanternsecurity/readme-updates
More work on auto docs publishing
- Loading branch information
Showing
23 changed files
with
569 additions
and
166 deletions.
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -78,7 +78,7 @@ jobs: | |
| uses: EndBug/add-and-commit@v9 | ||
| continue-on-error: true | ||
| with: | ||
| add: "*.md" | ||
| add: '["*.md", "docs/data/chord_graph/*.json"]' | ||
| author_name: "BBOT Docs Autopublish" | ||
| author_email: [email protected] | ||
| message: "Refresh module docs" | ||
|
|
@@ -102,21 +102,27 @@ jobs: | |
| run: | | ||
| pip install poetry | ||
| poetry install --only=docs | ||
| - name: Publish docs (stable branch) | ||
| - name: Configure Git | ||
| run: | | ||
| git config user.name github-actions | ||
| git config user.email [email protected] | ||
| git fetch origin gh-pages:refs/remotes/origin/gh-pages | ||
| if git show-ref --verify --quiet refs/heads/gh-pages; then | ||
| git branch -f gh-pages origin/gh-pages | ||
| else | ||
| git branch --track gh-pages origin/gh-pages | ||
| fi | ||
| - name: Generate docs (stable branch) | ||
| if: github.ref == 'refs/heads/stable' | ||
| run: | | ||
| poetry run mkdocs build -f mkdocs.yml | ||
| poetry run mkdocs gh-deploy --force --dir=site | ||
| - name: Publish docs (dev branch) | ||
| poetry run mike deploy Stable | ||
| - name: Generate docs (dev branch) | ||
| if: github.ref == 'refs/heads/dev' | ||
| run: | | ||
| poetry run mkdocs build -f mkdocs.yml -d site/dev_branch | ||
| git config user.name github-actions | ||
| git config user.email [email protected] | ||
| git checkout gh-pages | ||
| mv site/dev_branch . | ||
| git add dev_branch | ||
| git commit -m "Update dev documentation" | ||
| poetry run mike deploy Dev | ||
| - name: Publish docs | ||
| run: | | ||
| git switch gh-pages | ||
| git push | ||
| publish_code: | ||
| needs: update_docs | ||
|
|
||
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
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
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.