Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(build): #940 mkdocs gh-deploy #1021

Merged
merged 1 commit into from
Mar 8, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 3 additions & 13 deletions .github/workflows/prod.yml
Original file line number Diff line number Diff line change
Expand Up @@ -162,27 +162,17 @@ jobs:
env:
CACHIX_AUTH_TOKEN: ${{ secrets.CACHIX_AUTH_TOKEN }}

linux_docs:
linux_docs_deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@2541b1294d2704b0964813337f33b291d3f8596b
- uses: docker://docker.io/nixos/nix@sha256:1d13ae379fb8caf3f859c5ce7ec6002643d60cf8b7b6147b949cc34880c93bac
name: /docs
name: /docs/gh-deploy
with:
set-safe-directory: /github/workspace
args: sh -c "nix-env -if . && m . /docs"
args: sh -c "nix-env -if . && m . /docs gh-deploy"
env:
CACHIX_AUTH_TOKEN: ${{ secrets.CACHIX_AUTH_TOKEN }}
- name: deploy
uses: peaceiris/actions-gh-pages@v3
with:
force_orphan: true
full_commit_message: ${{ github.event.head_commit.message }}
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_branch: docs
publish_dir: docs/site
user_name: github-actions[bot]
user_email: github-actions[bot]@users.noreply.github.com

linux_envVars_example:
runs-on: ubuntu-latest
Expand Down
2 changes: 1 addition & 1 deletion docs/mkdocs.yml → docs/mkdocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ repo_url: https://github.com/fluidattacks/makes
repo_name: Makes
copyright: Copyright © 2023 Fluid Attacks, We hack your software. All rights reserved.

docs_dir: src
strict: true
docs_dir: src
theme:
name: material
markdown_extensions:
Expand Down
7 changes: 0 additions & 7 deletions makes/docs/dev/entrypoint.sh

This file was deleted.

10 changes: 0 additions & 10 deletions makes/docs/dev/main.nix

This file was deleted.

4 changes: 3 additions & 1 deletion makes/docs/entrypoint.sh
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
# shellcheck shell=bash

function main {
mkdocs build -f docs/mkdocs.yml
: \
&& pushd docs \
&& mkdocs "${@}"
}

main "${@}"
5 changes: 4 additions & 1 deletion makes/docs/runtime/main.nix
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,10 @@
...
}:
makeSearchPaths {
bin = [inputs.nixpkgs.mkdocs];
bin = [
inputs.nixpkgs.git
inputs.nixpkgs.mkdocs
];
source = [
(makePythonPypiEnvironment {
name = "docs-runtime-pypi";
Expand Down