From 0decc7251f7e83657168c539618ece6aeb1d36dc Mon Sep 17 00:00:00 2001 From: Carlos A Becker Date: Tue, 12 Oct 2021 16:41:32 -0300 Subject: [PATCH] chore(ci): tasks Signed-off-by: Carlos A Becker --- .github/workflows/docs.yml | 6 ++++-- .github/workflows/generate.yml | 7 +++++-- .gitignore | 1 + Taskfile.yml | 19 +++++++++++++++++++ 4 files changed, 29 insertions(+), 4 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index cac6e90..25cfde6 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -16,10 +16,12 @@ jobs: - name: checkout uses: actions/checkout@v2 + - + name: Set up Task + uses: arduino/setup-task@v1 - name: build - run: | - docker run --rm -v ${PWD}/www:/docs squidfunk/mkdocs-material build + run: task docs:build - name: htmltest uses: wjdp/htmltest-action@master diff --git a/.github/workflows/generate.yml b/.github/workflows/generate.yml index 7872f32..8143e39 100644 --- a/.github/workflows/generate.yml +++ b/.github/workflows/generate.yml @@ -23,8 +23,11 @@ jobs: with: go-version: 1.17 - - name: docs - run: ./scripts/cmd_docs.sh + name: Set up Task + uses: arduino/setup-task@v1 + - + name: Refresh docs + run: task docs:generate - uses: stefanzweifel/git-auto-commit-action@v4 with: commit_message: "docs: update cmd docs" diff --git a/.gitignore b/.gitignore index a3a0594..bba4e0c 100644 --- a/.gitignore +++ b/.gitignore @@ -14,3 +14,4 @@ www/site .idea/ testdata/acceptance/tmp/ completions/ +.task/ diff --git a/Taskfile.yml b/Taskfile.yml index 76b2eaf..1cba23e 100644 --- a/Taskfile.yml +++ b/Taskfile.yml @@ -83,6 +83,18 @@ tasks: cmds: - task: ci + docs:generate: + desc: Generate docs + cmds: + - ./scripts/cmd_docs.sh + sources: + - cmd/*.go + - ./scripts/cmd_docs.sh + - CONTRIBUTING.md + generates: + - www/docs/cmd/*.md + - www/docs/contributing.md + docs:imgs: desc: Download and resize images cmds: @@ -95,8 +107,15 @@ tasks: docs:serve: desc: Start documentation server cmds: + - task: docs:generate - '{{.DOCKER}} run --rm -it -p 8000:8000 -v ${PWD}/www:/docs docker.io/squidfunk/mkdocs-material' + docs:build: + desc: Build docs + cmds: + - task: docs:generate + - '{{.DOCKER}} run --rm -v ${PWD}/www:/docs docker.io/squidfunk/mkdocs-material build' + docs:vercel:build: desc: Build documentation for deploying to Vercel cmds: