From 5c95debb992a58707b404a6c24088dfa67ecfa77 Mon Sep 17 00:00:00 2001 From: nolte Date: Sun, 7 Jan 2024 23:30:04 +0100 Subject: [PATCH] bump up docs (#226) fix typos --- .devcontainer/devcontainer.json | 24 +++++++++ .github/ISSUE_TEMPLATE/bug_report.md | 20 +++---- .github/ISSUE_TEMPLATE/feature_request.md | 8 +-- .github/styles/Vocab/technical/accept.txt | 6 +++ .github/workflows/automerge.yaml | 2 +- .github/workflows/build-static-tests.yaml | 6 +-- .github/workflows/dependency-review.yaml | 2 +- .github/workflows/release-cd-deliver-docs.yml | 2 +- .../workflows/release-cd-refresh-master.yml | 17 +++++- .github/workflows/release-drafter.yml | 2 +- ...yaml => reusable-ansible-galaxy-push.yaml} | 0 ...le.yaml => reusable-ansible-molecule.yaml} | 0 ...automerge.yaml => reusable-automerge.yaml} | 0 ...n-bench.yaml => reusable-chain-bench.yaml} | 0 ...w.yaml => reusable-dependency-review.yaml} | 0 ...eable-mkdocs.yaml => reusable-mkdocs.yaml} | 0 ...e-commit.yaml => reusable-pre-commit.yaml} | 0 ...=> reusable-release-cd-refresh-master.yml} | 0 ...after.yml => reusable-release-drafter.yml} | 0 ...eable-sphinx.yaml => reusable-sphinx.yaml} | 0 ...useable-stale.yaml => reusable-stale.yaml} | 0 ...ble-tf-lint.yaml => reusable-tf-lint.yaml} | 0 ...useable-trivy.yaml => reusable-trivy.yaml} | 0 .github/workflows/stale.yaml | 2 +- .gitignore | 1 + .vale.ini | 19 +++++++ README.md | 53 ++++++++++--------- Taskfile.yml | 12 +++-- docs/index.md | 2 +- docs/probot.md | 19 ++++--- docs/workflows.md | 4 +- taskfiles/py-venv-dev.yaml | 8 ++- 32 files changed, 141 insertions(+), 68 deletions(-) create mode 100644 .devcontainer/devcontainer.json create mode 100644 .github/styles/Vocab/technical/accept.txt rename .github/workflows/{reuseable-ansible-galaxy-push.yaml => reusable-ansible-galaxy-push.yaml} (100%) rename .github/workflows/{reuseable-ansible-molecule.yaml => reusable-ansible-molecule.yaml} (100%) rename .github/workflows/{reuseable-automerge.yaml => reusable-automerge.yaml} (100%) rename .github/workflows/{reuseable-chain-bench.yaml => reusable-chain-bench.yaml} (100%) rename .github/workflows/{reuseable-dependency-review.yaml => reusable-dependency-review.yaml} (100%) rename .github/workflows/{reuseable-mkdocs.yaml => reusable-mkdocs.yaml} (100%) rename .github/workflows/{reuseable-pre-commit.yaml => reusable-pre-commit.yaml} (100%) rename .github/workflows/{reuseable-release-cd-refresh-master.yml => reusable-release-cd-refresh-master.yml} (100%) rename .github/workflows/{reuseable-release-drafter.yml => reusable-release-drafter.yml} (100%) rename .github/workflows/{reuseable-sphinx.yaml => reusable-sphinx.yaml} (100%) rename .github/workflows/{reuseable-stale.yaml => reusable-stale.yaml} (100%) rename .github/workflows/{reuseable-tf-lint.yaml => reusable-tf-lint.yaml} (100%) rename .github/workflows/{reuseable-trivy.yaml => reusable-trivy.yaml} (100%) create mode 100644 .vale.ini diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json new file mode 100644 index 0000000..4776ab0 --- /dev/null +++ b/.devcontainer/devcontainer.json @@ -0,0 +1,24 @@ +// For format details, see https://aka.ms/devcontainer.json. For config options, see the +// README at: https://github.com/devcontainers/templates/tree/main/src/alpine +{ + "name": "Alpine", + // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile + "image": "mcr.microsoft.com/devcontainers/base:alpine-3.17", + // Features to add to the dev container. More info: https://containers.dev/features. + "features": { + "ghcr.io/devcontainers/features/common-utils:2": { + + }, + "ghcr.io/devcontainers-contrib/features/asdf-package:1": { + "plugin": "argocd" + } + } + // Use 'forwardPorts' to make a list of ports inside the container available locally. + // "forwardPorts": [], + // Use 'postCreateCommand' to run commands after the container is created. + // "postCreateCommand": "uname -a", + // Configure tool-specific properties. + // "customizations": {}, + // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root. + // "remoteUser": "root" +} \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index a786dae..e0c18cc 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -13,25 +13,25 @@ Thank you for opening an issue. ---> -### Used Release +### Used release -### Debug Output +### Debug output -### Panic Output +### Panic output -### Expected Behavior +### Expected behavior What should have happened? -### Actual Behavior +### Actual behavior What actually happened? -### Steps to Reproduce +### Steps to reproduce -### Important Factoids +### Important factoids ### References @@ -39,7 +39,7 @@ What actually happened? - GH-1234 --> -### Community Note +### Community note -* Please vote on this issue by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original issue to help the community and maintainers prioritize this request -* If you are interested in working on this issue or have submitted a pull request, please leave a comment +* Please vote on this issue by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original issue to help the community and maintainers rank this request +* If you interested in working on this issue or have submitted a pull request, please leave a comment diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 0ba88c2..893cf0a 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -11,7 +11,7 @@ labels: enhancement -### Potential Configuration +### Potential configuration @@ -29,9 +29,9 @@ Are there any other GitHub issues (open or closed) or pull requests that should -### Community Note +### Community note -* Please vote on this issue by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original issue to help the community and maintainers prioritize this request -* If you are interested in working on this issue or have submitted a pull request, please leave a comment +* Please vote on this issue by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original issue to help the community and maintainers rank this request +* If you interested in working on this issue or have submitted a pull request, please leave a comment diff --git a/.github/styles/Vocab/technical/accept.txt b/.github/styles/Vocab/technical/accept.txt new file mode 100644 index 0000000..4a9575b --- /dev/null +++ b/.github/styles/Vocab/technical/accept.txt @@ -0,0 +1,6 @@ +Ansible +asdf +mkdocs +Probot +probot +zsh diff --git a/.github/workflows/automerge.yaml b/.github/workflows/automerge.yaml index 1a61ec3..c3d35cf 100644 --- a/.github/workflows/automerge.yaml +++ b/.github/workflows/automerge.yaml @@ -19,6 +19,6 @@ on: jobs: automerge: - uses: nolte/gh-plumbing/.github/workflows/reuseable-automerge.yaml@develop + uses: nolte/gh-plumbing/.github/workflows/reusable-automerge.yaml@develop secrets: token: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/build-static-tests.yaml b/.github/workflows/build-static-tests.yaml index 4227b9e..941dde3 100644 --- a/.github/workflows/build-static-tests.yaml +++ b/.github/workflows/build-static-tests.yaml @@ -3,10 +3,10 @@ on: jobs: static: - uses: nolte/gh-plumbing/.github/workflows/reuseable-pre-commit.yaml@develop + uses: nolte/gh-plumbing/.github/workflows/reusable-pre-commit.yaml@develop security: - uses: nolte/gh-plumbing/.github/workflows/reuseable-trivy.yaml@develop + uses: nolte/gh-plumbing/.github/workflows/reusable-trivy.yaml@develop chain-bench: - uses: nolte/gh-plumbing/.github/workflows/reuseable-chain-bench.yaml@develop + uses: nolte/gh-plumbing/.github/workflows/reusable-chain-bench.yaml@develop secrets: token: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/dependency-review.yaml b/.github/workflows/dependency-review.yaml index 4d8303d..c0c7d3e 100644 --- a/.github/workflows/dependency-review.yaml +++ b/.github/workflows/dependency-review.yaml @@ -8,4 +8,4 @@ permissions: jobs: dependency-review: - uses: nolte/gh-plumbing/.github/workflows/reuseable-dependency-review.yaml@develop + uses: nolte/gh-plumbing/.github/workflows/reusable-dependency-review.yaml@develop diff --git a/.github/workflows/release-cd-deliver-docs.yml b/.github/workflows/release-cd-deliver-docs.yml index 825368e..2f7165f 100644 --- a/.github/workflows/release-cd-deliver-docs.yml +++ b/.github/workflows/release-cd-deliver-docs.yml @@ -4,6 +4,6 @@ on: jobs: publish_docs: - uses: nolte/gh-plumbing/.github/workflows/reuseable-mkdocs.yaml@develop + uses: nolte/gh-plumbing/.github/workflows/reusable-mkdocs.yaml@develop secrets: token: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/release-cd-refresh-master.yml b/.github/workflows/release-cd-refresh-master.yml index a17d670..fa8a810 100644 --- a/.github/workflows/release-cd-refresh-master.yml +++ b/.github/workflows/release-cd-refresh-master.yml @@ -4,6 +4,21 @@ on: jobs: refresh_presentation_branch: - uses: nolte/gh-plumbing/.github/workflows/reuseable-release-cd-refresh-master.yml@develop + uses: nolte/gh-plumbing/.github/workflows/reusable-release-cd-refresh-master.yml@develop secrets: token: ${{ secrets.GITHUB_TOKEN }} + + archive: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@master + - uses: vimtor/action-zip@v1.1 + with: + files: .github/styles/ .vale.ini + dest: result.zip + + - name: Upload Release + uses: ncipollo/release-action@v1.12.0 + with: + artifacts: "vale-styles.zip" + token: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/release-drafter.yml b/.github/workflows/release-drafter.yml index 647e5c4..270d92a 100644 --- a/.github/workflows/release-drafter.yml +++ b/.github/workflows/release-drafter.yml @@ -6,6 +6,6 @@ on: jobs: update_release_draft: - uses: nolte/gh-plumbing/.github/workflows/reuseable-release-drafter.yml@develop + uses: nolte/gh-plumbing/.github/workflows/reusable-release-drafter.yml@develop secrets: token: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/reuseable-ansible-galaxy-push.yaml b/.github/workflows/reusable-ansible-galaxy-push.yaml similarity index 100% rename from .github/workflows/reuseable-ansible-galaxy-push.yaml rename to .github/workflows/reusable-ansible-galaxy-push.yaml diff --git a/.github/workflows/reuseable-ansible-molecule.yaml b/.github/workflows/reusable-ansible-molecule.yaml similarity index 100% rename from .github/workflows/reuseable-ansible-molecule.yaml rename to .github/workflows/reusable-ansible-molecule.yaml diff --git a/.github/workflows/reuseable-automerge.yaml b/.github/workflows/reusable-automerge.yaml similarity index 100% rename from .github/workflows/reuseable-automerge.yaml rename to .github/workflows/reusable-automerge.yaml diff --git a/.github/workflows/reuseable-chain-bench.yaml b/.github/workflows/reusable-chain-bench.yaml similarity index 100% rename from .github/workflows/reuseable-chain-bench.yaml rename to .github/workflows/reusable-chain-bench.yaml diff --git a/.github/workflows/reuseable-dependency-review.yaml b/.github/workflows/reusable-dependency-review.yaml similarity index 100% rename from .github/workflows/reuseable-dependency-review.yaml rename to .github/workflows/reusable-dependency-review.yaml diff --git a/.github/workflows/reuseable-mkdocs.yaml b/.github/workflows/reusable-mkdocs.yaml similarity index 100% rename from .github/workflows/reuseable-mkdocs.yaml rename to .github/workflows/reusable-mkdocs.yaml diff --git a/.github/workflows/reuseable-pre-commit.yaml b/.github/workflows/reusable-pre-commit.yaml similarity index 100% rename from .github/workflows/reuseable-pre-commit.yaml rename to .github/workflows/reusable-pre-commit.yaml diff --git a/.github/workflows/reuseable-release-cd-refresh-master.yml b/.github/workflows/reusable-release-cd-refresh-master.yml similarity index 100% rename from .github/workflows/reuseable-release-cd-refresh-master.yml rename to .github/workflows/reusable-release-cd-refresh-master.yml diff --git a/.github/workflows/reuseable-release-drafter.yml b/.github/workflows/reusable-release-drafter.yml similarity index 100% rename from .github/workflows/reuseable-release-drafter.yml rename to .github/workflows/reusable-release-drafter.yml diff --git a/.github/workflows/reuseable-sphinx.yaml b/.github/workflows/reusable-sphinx.yaml similarity index 100% rename from .github/workflows/reuseable-sphinx.yaml rename to .github/workflows/reusable-sphinx.yaml diff --git a/.github/workflows/reuseable-stale.yaml b/.github/workflows/reusable-stale.yaml similarity index 100% rename from .github/workflows/reuseable-stale.yaml rename to .github/workflows/reusable-stale.yaml diff --git a/.github/workflows/reuseable-tf-lint.yaml b/.github/workflows/reusable-tf-lint.yaml similarity index 100% rename from .github/workflows/reuseable-tf-lint.yaml rename to .github/workflows/reusable-tf-lint.yaml diff --git a/.github/workflows/reuseable-trivy.yaml b/.github/workflows/reusable-trivy.yaml similarity index 100% rename from .github/workflows/reuseable-trivy.yaml rename to .github/workflows/reusable-trivy.yaml diff --git a/.github/workflows/stale.yaml b/.github/workflows/stale.yaml index b199ef7..e964c72 100644 --- a/.github/workflows/stale.yaml +++ b/.github/workflows/stale.yaml @@ -4,6 +4,6 @@ on: jobs: stale: - uses: nolte/gh-plumbing/.github/workflows/reuseable-stale.yaml@develop + uses: nolte/gh-plumbing/.github/workflows/reusable-stale.yaml@develop secrets: token: ${{ secrets.GITHUB_TOKEN }} diff --git a/.gitignore b/.gitignore index 1320f90..51b449b 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ site +.github/styles/Microsoft diff --git a/.vale.ini b/.vale.ini new file mode 100644 index 0000000..a80612f --- /dev/null +++ b/.vale.ini @@ -0,0 +1,19 @@ +StylesPath = ".github/styles" +MinAlertLevel = suggestion + +Vocab = "technical" + +Packages = Microsoft + +IgnoredScopes = code,tt, em + + +[*.md] +BasedOnStyles = Vale, Microsoft + +TokenIgnores = \(\/.*?\), \ + {%.*?%}, \ + {{.*?}}, \ + (.|\/|-)?github(\/|-)?, \ + (+?) + diff --git a/README.md b/README.md index 419859e..5d10ecc 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ # Plumbing -[![Github Project Stars](https://img.shields.io/github/stars/nolte/gh-plumbing.svg?label=Stars&style=social)](https://github.com/nolte/gh-plumbing) [![Github Issue Tracking](https://img.shields.io/github/issues-raw/nolte/gh-plumbing.svg)](https://github.com/nolte/gh-plumbing) [![Github LatestRelease](https://img.shields.io/github/release/nolte/gh-plumbing.svg)](https://github.com/nolte/gh-plumbing) [![.github/workflows/build-static-tests.yaml](https://github.com/nolte/gh-plumbing/actions/workflows/build-static-tests.yaml/badge.svg)](https://github.com/nolte/gh-plumbing/actions/workflows/build-static-tests.yaml) [![.github/workflows/release-cd-deliver-docs.yml](https://github.com/nolte/gh-plumbing/actions/workflows/release-cd-deliver-docs.yml/badge.svg)](https://github.com/nolte/gh-plumbing/actions/workflows/release-cd-deliver-docs.yml) +[![GitHub Project Stars](https://img.shields.io/github/stars/nolte/gh-plumbing.svg?label=Stars&style=social)](https://github.com/nolte/gh-plumbing) [![GitHub Issue Tracking](https://img.shields.io/github/issues-raw/nolte/gh-plumbing.svg)](https://github.com/nolte/gh-plumbing) [![GitHub LatestRelease](https://img.shields.io/github/release/nolte/gh-plumbing.svg)](https://github.com/nolte/gh-plumbing) [![.github/workflows/build-static-tests.yaml](https://github.com/nolte/gh-plumbing/actions/workflows/build-static-tests.yaml/badge.svg)](https://github.com/nolte/gh-plumbing/actions/workflows/build-static-tests.yaml) [![.github/workflows/release-cd-deliver-docs.yml](https://github.com/nolte/gh-plumbing/actions/workflows/release-cd-deliver-docs.yml/badge.svg)](https://github.com/nolte/gh-plumbing/actions/workflows/release-cd-deliver-docs.yml) --- -Used for deduplicate the CI/CD Boilerplate-Code. Like [Workflow](https://docs.github.com/en/actions) and [Github App](https://docs.github.com/en/developers/apps/getting-started-with-apps/about-apps) configurations. +Used for minimize duplicate the CI/CD Boilerplate-Code. Like [Workflows (GitHub Actions)](https://docs.github.com/en/actions) and [GitHub App](https://docs.github.com/en/developers/apps/getting-started-with-apps/about-apps) configurations. ## Workflows @@ -13,57 +13,58 @@ Used for deduplicate the CI/CD Boilerplate-Code. Like [Workflow](https://docs.gi | Workflow | description | |-----------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| ```reuseable-ansible-galaxy-push.yaml``` | Using [robertdebock/galaxy-action](https://github.com/robertdebock/galaxy-action) for publish a Ansible Role to [Ansible Galxy](https://galaxy.ansible.com/). | -| ```reuseable-ansible-molecule.yaml``` | Start a simple Molecule test run by using the [gofrolist/molecule-action](https://github.com/gofrolist/molecule-action) action. | -| ```reuseable-automerge.yaml``` | Using [pascalgn/automerge-action](https://github.com/pascalgn/automerge-action) for better Merge Request handling. | -| ```reuseable-mkdocs.yaml``` | Publish a [mkdocs](https://www.mkdocs.org/) based Documentation as [Github Page](https://pages.github.com/). | -| ```reuseable-pre-commit.yaml``` | Call [pre-commit](https://pre-commit.com/) for a minimal static tests set, like liter etc. | -| ```reuseable-release-cd-refresh-master.yml``` | Refresh the current master branch, with the Revision from the Latest published Release, so the master/main branch will be present the `latest` Released version. | -| ```reuseable-release-drafter.yml``` | Will be use [release-drafter/release-drafter](https://github.com/release-drafter/release-drafter) for updating the current "Draft" Release with a Changelog. | -| ```reuseable-sphinx.yaml``` | Build and Publish a [Sphinx](https://www.sphinx-doc.org/en/master) Documentation as [Github Page](https://pages.github.com/). | -| ```reuseable-stale.yaml``` | Mark old or inactive issues and close then, used [actions/stale](https://github.com/actions/stale) for this work. | -| ```reuseable-trivy.yaml``` | Scan the GitRepo by using [aquasecurity/trivy-action](https://github.com/aquasecurity/trivy-action). | -| ```reuseable-tf-lint.yaml``` | Use [terraform-linters/setup-tflint](https://github.com/terraform-linters/setup-tflint) for Lint terraform sources. | +| ```reusable-ansible-galaxy-push.yaml``` | Using [robertdebock/galaxy-action](https://github.com/robertdebock/galaxy-action) for publish a Ansible Role to [Ansible Galxy](https://galaxy.ansible.com/). | +| ```reusable-ansible-molecule.yaml``` | Start a simple Molecule test run by using the [gofrolist/molecule-action](https://github.com/gofrolist/molecule-action) action. | +| ```reusable-automerge.yaml``` | Using [pascalgn/automerge-action](https://github.com/pascalgn/automerge-action) for better Merge Request handling. | +| ```reusable-mkdocs.yaml``` | Publish a [mkdocs](https://www.mkdocs.org/) based Documentation as [GitHub Page](https://pages.github.com/). | +| ```reusable-pre-commit.yaml``` | Call [pre-commit](https://pre-commit.com/) for a minimal static tests set, like liter etc. | +| ```reusable-release-cd-refresh-master.yml``` | Refresh the current master branch, with the Revision from the Latest published Release, so the master/main branch will be present the `latest` Released version. | +| ```reusable-release-drafter.yml``` | Will be use [release-drafter/release-drafter](https://github.com/release-drafter/release-drafter) for updating the current "Draft" Release with a Changelog. | +| ```reusable-sphinx.yaml``` | Build and Publish a [Sphinx](https://www.sphinx-doc.org/en/master) Documentation as [GitHub Page](https://pages.github.com/). | +| ```reusable-stale.yaml``` | Mark old or inactive issues and close then, used [actions/stale](https://github.com/actions/stale) for this work. | +| ```reusable-trivy.yaml``` | Scan the GitRepo by using [aquasecurity/trivy-action](https://github.com/aquasecurity/trivy-action). | +| ```reusable-tf-lint.yaml``` | Use [terraform-linters/setup-tflint](https://github.com/terraform-linters/setup-tflint) for Lint terraform sources. | + -## Probot Config + +## Probot configuration -Collection of common Configs for Project Management and CI/CD. -For Using in other Github Projects, having a reuseable set of Probot Config Repo, more informations at [probot.github.io](https://probot.github.io/docs/best-practices/#configuration). +Collection of common Configurations for Project Management and CI/CD. +For Using in other GitHub Projects, having a reusable set of Probot Configuration Repository, more information at [probot.github.io](https://probot.github.io/docs/best-practices/#configuration). | probot | git | description | |-------------------------------------------------------------------|-----------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------| -| [boring-cyborg](https://probot.github.io/apps/boring-cyborg/) | [kaxil/boring-cyborg](https://github.com/kaxil/boring-cyborg) | Different util actions like, automatically label Pull Request | +| [boring-cyborg](https://probot.github.io/apps/boring-cyborg/) | [kaxil/boring-cyborg](https://github.com/kaxil/boring-cyborg) | Different actions like, automatically label Pull Request | | [release-drafter](https://probot.github.io/apps/release-drafter/) | [toolmantim/release-drafter](https://github.com/toolmantim/release-drafter) | Creates a Human Readable Release Change Log (**(deprecated)**, please use the Workflow Implementation). | | [renovate](https://github.com/apps/renovate) | | Using [renovate](https://www.whitesourcesoftware.com/free-developer-tools/renovate/) for keep dependencies in sync. | -| [settings](https://probot.github.io/apps/settings/) | [probot/settings](https://github.com/probot/settings) | Configure Github Projects by Source. | +| [settings](https://probot.github.io/apps/settings/) | [probot/settings](https://github.com/probot/settings) | Configure GitHub Projects by Source. | -For More Inforation take a look to the GH Page, [gh-plumbing](http://nolte.github.io/gh-plumbing). +For More information take a look to the GH Page, [gh-plumbing](http://nolte.github.io/gh-plumbing). ## Development -We use the [asdf](https://asdf-vm.com/) Packagemanager. +Use the [asdf](https://asdf-vm.com/) package manager. ```sh asdf install ``` -### Worflows +### Workflows For local testing you can use [nektos/act](https://github.com/nektos/act), run the GitHub Actions locally. ```sh -act --job=static +act push -j static -W .github/workflows/build-static-tests.yaml ``` -will be start the [![.github/workflows/build-static-tests.yaml](https://github.com/nolte/gh-plumbing/actions/workflows/build-static-tests.yaml/badge.svg)](https://github.com/nolte/gh-plumbing/actions/workflows/build-static-tests.yaml) at your local system. +Will be start the [![.github/workflows/build-static-tests.yaml](https://github.com/nolte/gh-plumbing/actions/workflows/build-static-tests.yaml/badge.svg)](https://github.com/nolte/gh-plumbing/actions/workflows/build-static-tests.yaml) at your system. -**For the Moment blocked by [#826](https://github.com/nektos/act/issues/826)**. ### Documentation @@ -76,12 +77,12 @@ pip install -r requirements-dev.txt mkdocs serve -a localhost:8001 ``` -Open [localhost:8001](http://localhost:8001/) for take a look to the lastest documentation, created with [mkdocs](https://www.mkdocs.org/). +Open [localhost:8001](http://localhost:8001/) for take a look to the latest documentation, created with [mkdocs](https://www.mkdocs.org/). ### Task -We use [go-task/task](https://github.com/go-task/task) as alias tooling. +Use [go-task/task](https://github.com/go-task/task) as pre-configured command sets. ```sh task -l diff --git a/Taskfile.yml b/Taskfile.yml index de928da..7b12fda 100644 --- a/Taskfile.yml +++ b/Taskfile.yml @@ -3,7 +3,10 @@ version: '3' vars: - PYTHON_VENVS_BASEDIR: ~/.vens/ + PYTHON_VENVS_BASEDIR: ~/.venvs/ + + PYTHON_BIN: python3 + VENVS: .venvs/ includes: py-dev: ./taskfiles/py-venv-dev.yaml @@ -18,7 +21,8 @@ tasks: mkdocs: desc: Start the Mkdocs, for development - deps: ["py-dev:venv-usage"] + #deps: ["py-dev:venv-usage"] cmds: - - mkdocs serve -a localhost:8001 - silent: true + - task: py-dev:venv-usage + #- mkdocs serve -a localhost:8001 + silent: false diff --git a/docs/index.md b/docs/index.md index 8928c01..a2e4541 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,4 +1,4 @@ -# Shared Configs +# Shared configurations {% include-markdown "../README.md" diff --git a/docs/probot.md b/docs/probot.md index 000b806..a813a65 100644 --- a/docs/probot.md +++ b/docs/probot.md @@ -1,5 +1,4 @@ -# Shared Probot Configs - +# Shared Probot configuration {% include-markdown "../README.md" @@ -13,10 +12,10 @@ Example: _extends: gh-plumbing:.github/boring-cyborg.yml ``` -The Reuseable configurations are prefixed with ```.github/commons-*.yml```. +The Reusable configurations prefixed with ```.github/commons-*.yml```. -### Shared Configs +### Shared configuration {% include-markdown "../README.md" @@ -24,9 +23,9 @@ The Reuseable configurations are prefixed with ```.github/commons-*.yml```. end="" %} -#### Project Settings +#### Project settings -For Central Project Configuration we use the [settings](https://probot.github.io/apps/settings/) Github App. +For Central Project Configuration use the [settings](https://probot.github.io/apps/settings/) GitHub App. This Applications will be handle: @@ -48,7 +47,7 @@ repository: #### Labelling -For Handle PR and Issue Labels we use [boring-cyborg](https://probot.github.io/apps/boring-cyborg/) for setting labels by Existing roles, like changes at `./docs` allways get the Label `documentations`. +For Handle PR and Issue Labels use [boring-cyborg](https://probot.github.io/apps/boring-cyborg/) for setting labels by Existing roles, like changes at `./docs` always get the Label `documentations`. ##### Usage @@ -58,7 +57,7 @@ For Handle PR and Issue Labels we use [boring-cyborg](https://probot.github.io/a %} ``` -##### Labelling Rules +##### Labelling rules ```yaml {% @@ -68,7 +67,7 @@ For Handle PR and Issue Labels we use [boring-cyborg](https://probot.github.io/a %} ``` -##### Existing Labels +##### Existing labels ```yaml {% @@ -77,4 +76,4 @@ For Handle PR and Issue Labels we use [boring-cyborg](https://probot.github.io/a end="# " %} ``` -The labels will be preconfigured by use the [Settings](#project-settings) Github Application. +The labels will be pre-configured by use the [Settings](#project-settings) GitHub Application. diff --git a/docs/workflows.md b/docs/workflows.md index 64c700d..7721348 100644 --- a/docs/workflows.md +++ b/docs/workflows.md @@ -1,4 +1,4 @@ -# Reuseable Workflows +# Reusable workflows This part of the Documentation will be describe the [reusing-workflows](https://docs.github.com/en/actions/learn-github-actions/reusing-workflows#overview). @@ -9,4 +9,4 @@ This part of the Documentation will be describe the [reusing-workflows](https:// end="" %} -The Reuseable workflows are prefixed with ```.github/workflows/reuseable-*.yml```. +The Reusable workflows prefixed with ```.github/workflows/reusable-*.yml```. diff --git a/taskfiles/py-venv-dev.yaml b/taskfiles/py-venv-dev.yaml index a63d2a0..230f850 100644 --- a/taskfiles/py-venv-dev.yaml +++ b/taskfiles/py-venv-dev.yaml @@ -3,9 +3,13 @@ version: '3' vars: - PYTHON_VENV_DIR: "{{.PYTHON_VENVS_BASEDIR}}/development" + PYTHON_VENV_DIR: "{{.PYTHON_VENVS_BASEDIR}}/docs" tasks: venv-usage: cmds: - - source {{.PYTHON_VENV_DIR}}/bin/activate + - | + bash -c " + source {{.PYTHON_VENV_DIR}}/bin/activate && \ + mkdocs serve -a localhost:8001 + "