From ca6b11b4254e239b8925c9fb1d14303c0c373e37 Mon Sep 17 00:00:00 2001 From: John Bampton Date: Tue, 15 Dec 2020 11:01:37 +1000 Subject: [PATCH] feat: add a GitHub action to lint the YAML files Lint some YAML Add a `.yamllint` config file --- .asf.yaml | 6 ++-- .github/workflows/build.yml | 4 +-- .github/workflows/check.yml | 28 +++++++++--------- .github/workflows/doc.yml | 58 ++++++++++++++++++------------------- .github/workflows/lint.yml | 12 ++++++++ .yamllint | 8 +++++ 6 files changed, 68 insertions(+), 48 deletions(-) create mode 100644 .github/workflows/lint.yml create mode 100644 .yamllint diff --git a/.asf.yaml b/.asf.yaml index c1200bb79b..c71e5702fa 100644 --- a/.asf.yaml +++ b/.asf.yaml @@ -15,8 +15,8 @@ github: - microcontroller enabled_merge_buttons: # disable squash button: - squash: false + squash: false # disable merge button: - merge: false + merge: false # enable rebase button: - rebase: true + rebase: true diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 9e27f42a4e..ce5ce76a7f 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -150,7 +150,7 @@ jobs: command: docker pull docker.pkg.github.com/apache/incubator-nuttx-testing/nuttx-ci-linux - name: Export NuttX Repo SHA - run: echo "nuttx_sha=`git -C sources/nuttx rev-parse HEAD`" >> $GITHUB_ENV + run: echo "nuttx_sha=`git -C sources/nuttx rev-parse HEAD`" >> $GITHUB_ENV - name: Run builds uses: ./sources/testing/.github/actions/ci-container env: @@ -193,7 +193,7 @@ jobs: key: ${{ runner.os }}-tools-${{ hashFiles('./sources/testing/cibuild.sh') }} - name: Export NuttX Repo SHA - run: echo "nuttx_sha=`git -C sources/nuttx rev-parse HEAD`" >> $GITHUB_ENV + run: echo "nuttx_sha=`git -C sources/nuttx rev-parse HEAD`" >> $GITHUB_ENV - name: Run Builds run: | echo "::add-matcher::sources/nuttx/.github/gcc.json" diff --git a/.github/workflows/check.yml b/.github/workflows/check.yml index 53221eda7d..387af54cd7 100644 --- a/.github/workflows/check.yml +++ b/.github/workflows/check.yml @@ -22,18 +22,18 @@ jobs: runs-on: ubuntu-18.04 steps: - - name: Checkout nuttx repo - uses: actions/checkout@v2 - with: - repository: apache/incubator-nuttx - path: nuttx - fetch-depth: 0 + - name: Checkout nuttx repo + uses: actions/checkout@v2 + with: + repository: apache/incubator-nuttx + path: nuttx + fetch-depth: 0 - - name: Check Pull Request - run: | - echo "::add-matcher::nuttx/.github/nxstyle.json" - cd nuttx - commits="${{ github.event.pull_request.base.sha }}..HEAD" - git log --oneline $commits - echo "../nuttx/tools/checkpatch.sh -g $commits" - ../nuttx/tools/checkpatch.sh -g $commits + - name: Check Pull Request + run: | + echo "::add-matcher::nuttx/.github/nxstyle.json" + cd nuttx + commits="${{ github.event.pull_request.base.sha }}..HEAD" + git log --oneline $commits + echo "../nuttx/tools/checkpatch.sh -g $commits" + ../nuttx/tools/checkpatch.sh -g $commits diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml index 5c3b6614e4..a3dbf2f95f 100644 --- a/.github/workflows/doc.yml +++ b/.github/workflows/doc.yml @@ -19,35 +19,35 @@ jobs: build-html: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v1 - - uses: actions/setup-python@v2 - with: - python-version: '3.8' - - name: Generate requirements.txt file - run: | - cd Documentation/ - pip3 install pipenv - pipenv lock -r > requirements.txt - - uses: ammaraskar/sphinx-problem-matcher@master - - uses: ammaraskar/sphinx-action@master - with: - docs-folder: "Documentation/" - - uses: actions/upload-artifact@v2 - with: - name: sphinx-docs - path: Documentation/_build/html/ + - uses: actions/checkout@v1 + - uses: actions/setup-python@v2 + with: + python-version: '3.8' + - name: Generate requirements.txt file + run: | + cd Documentation/ + pip3 install pipenv + pipenv lock -r > requirements.txt + - uses: ammaraskar/sphinx-problem-matcher@master + - uses: ammaraskar/sphinx-action@master + with: + docs-folder: "Documentation/" + - uses: actions/upload-artifact@v2 + with: + name: sphinx-docs + path: Documentation/_build/html/ linkcheck: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v1 - - uses: actions/setup-python@v2 - with: - python-version: '3.8' - - uses: ammaraskar/sphinx-problem-matcher@master - - name: Run linkcheck - run: | - cd Documentation/ - pip3 install pipenv - pipenv install - # This step flakes frequently so still annotate errors but dont fail the build - pipenv run make linkcheck || true + - uses: actions/checkout@v1 + - uses: actions/setup-python@v2 + with: + python-version: '3.8' + - uses: ammaraskar/sphinx-problem-matcher@master + - name: Run linkcheck + run: | + cd Documentation/ + pip3 install pipenv + pipenv install + # This step flakes frequently so still annotate errors but dont fail the build + pipenv run make linkcheck || true diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml new file mode 100644 index 0000000000..b85863ddf3 --- /dev/null +++ b/.github/workflows/lint.yml @@ -0,0 +1,12 @@ +name: ❄️ Lint + +on: [pull_request] + +jobs: + yamllint: + name: 🍺 YAML + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - name: 🧹 YAML Lint + uses: ibiqlik/action-yamllint@v3 diff --git a/.yamllint b/.yamllint new file mode 100644 index 0000000000..9c4a22a586 --- /dev/null +++ b/.yamllint @@ -0,0 +1,8 @@ +--- + +extends: default + +rules: + document-start: disable + line-length: disable + truthy: disable