diff options
| author | Ivan Zorin <[email protected]> | 2023-07-11 02:36:05 +0300 |
|---|---|---|
| committer | GitHub <[email protected]> | 2023-07-11 09:36:05 +1000 |
| commit | 4649df69145d0f3764d2df29439e232944ccce52 (patch) | |
| tree | bd239d2e61765028c91b01161839913c5a88ff89 /.github | |
| parent | cd7696b66f33b75409b236c64631540b8c05a3e6 (diff) | |
| download | IronOS-4649df69145d0f3764d2df29439e232944ccce52.tar.gz IronOS-4649df69145d0f3764d2df29439e232944ccce52.zip | |
Implement autogeneration of Documentation/README.md (#1738)
* mkdocs.yml: unify formatting style
* Docs/README.md: add auto-generated README.md file for Documentation/ directory
* Docs/README.md: fix refs
* Docs/README.md: fix locations
* Docs/README.md: trying workaround spaces in filenames for refs
* Documentation/README.md: update generated file trying to fix all formatting issues
* Documentation/README.md: reduce title size
* Documentation/README.md: add link for official online docs
* scripts/deploy.sh: implement docs_readme function
* deploy.sh: add overwrite warning in help output
* deploy.sh: try to fix shellcheck warnings
* deploy.sh:docs_readme() - show note message only if README should be updated
* deploy.sh:docs_readme() - fix shellcheck
* github/push: add Documentation/README.md check
* github/push: force usage of /bin/sh for deploy.sh script
* testing, testing, testing
* deploy.sh:docs_readme() - make error-related message more clear about what to donext
* Revert change used only to test failure on github CI
Diffstat (limited to '.github')
| -rw-r--r-- | .github/workflows/push.yml | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/.github/workflows/push.yml b/.github/workflows/push.yml index 765910f9..9f904a2a 100644 --- a/.github/workflows/push.yml +++ b/.github/workflows/push.yml @@ -140,7 +140,7 @@ jobs: steps: - name: deps - run: apk add --no-cache python3 py3-pip make git black + run: apk add --no-cache python3 py3-pip make git black sed diffutils - uses: actions/checkout@v3 with: @@ -158,6 +158,9 @@ jobs: - name: Check python with flake8 run: flake8 Translations + - name: Check autogenerated Documentation/README.md + run: /bin/sh ./scripts/deploy.sh docs_readme + shellcheck: name: runner / shellcheck runs-on: ubuntu-latest |