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

build: extend yamllint configuration #41756

Merged
merged 2 commits into from Feb 14, 2022
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/1-bug-report.yml
@@ -1,4 +1,4 @@
name: "\U0001F41B Bug report"
name: \U0001F41B Bug report
description: Create a report to help us improve
body:
- type: markdown
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/2-feature-request.yml
@@ -1,6 +1,6 @@
name: "\U0001F680 Feature request"
name: \U0001F680 Feature request
description: Suggest an idea for this project
labels: ["feature request"]
labels: [feature request]
body:
- type: markdown
attributes:
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/3-api-ref-docs-problem.yml
@@ -1,6 +1,6 @@
name: "\U0001F4D7 Open an issue regarding the Node.js API reference docs"
name: \U0001F4D7 Open an issue regarding the Node.js API reference docs
description: Let us know about any problematic API reference documents
labels: ["doc"]
labels: [doc]
body:
- type: markdown
attributes:
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/4-report-a-flaky-test.yml
@@ -1,6 +1,6 @@
name: Report a flaky test
description: Report a flaky test in our CI
labels: ["flaky-test"]
labels: [flaky-test]
body:
- type: markdown
attributes:
Expand Down
10 changes: 5 additions & 5 deletions .github/workflows/authors.yml
Expand Up @@ -2,7 +2,7 @@ name: Authors update
on:
schedule:
# Run once a week at 00:05 AM UTC on Sunday.
- cron: '5 0 * * 0'
- cron: 5 0 * * 0

workflow_dispatch:

Expand All @@ -15,7 +15,7 @@ jobs:
with:
fetch-depth: '0' # This is required to actually get all the authors
persist-credentials: false
- run: "tools/update-authors.js" # Run the AUTHORS tool
- run: tools/update-authors.js # Run the AUTHORS tool
- uses: gr2m/create-or-update-pull-request-action@v1 # Create a PR or update the Action's existing PR
env:
GITHUB_TOKEN: ${{ secrets.GH_USER_TOKEN }}
Expand All @@ -25,7 +25,7 @@ jobs:
Here are some new additions to the AUTHORS file.
This is an automatically generated PR by the
`authors.yml` GitHub Action, which runs `tools/update-authors.js`.
branch: "actions/authors-update" # Custom branch *just* for this Action.
commit-message: "meta: update AUTHORS"
branch: actions/authors-update # Custom branch *just* for this Action.
commit-message: 'meta: update AUTHORS'
labels: meta
title: "meta: update AUTHORS"
title: 'meta: update AUTHORS'
2 changes: 1 addition & 1 deletion .github/workflows/auto-start-ci.yml
Expand Up @@ -6,7 +6,7 @@ on:
# optimistic, it can take longer to run.
# To understand why `schedule` is used instead of other events, refer to
# ./doc/contributing/commit-queue.md
- cron: "*/5 * * * *"
- cron: '*/5 * * * *'

env:
NODE_VERSION: lts/*
Expand Down
12 changes: 6 additions & 6 deletions .github/workflows/build-tarball.yml
Expand Up @@ -4,10 +4,10 @@ on:
pull_request:
types: [opened, synchronize, reopened, ready_for_review]
paths-ignore:
- '.mailmap'
- .mailmap
- '**.md'
- 'AUTHORS'
- 'doc/**'
- AUTHORS
- doc/**
- .github/**
- '!.github/workflows/build-tarball.yml'
push:
Expand All @@ -17,10 +17,10 @@ on:
- v[0-9]+.x-staging
- v[0-9]+.x
paths-ignore:
- '.mailmap'
- .mailmap
- '**.md'
- 'AUTHORS'
- 'doc/**'
- AUTHORS
- doc/**
- .github/**
- '!.github/workflows/build-tarball.yml'

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/close-stalled.yml
@@ -1,7 +1,7 @@
name: Close stalled issues and PRs
on:
schedule:
- cron: "0 0 * * *"
- cron: 0 0 * * *

env:
CLOSE_MESSAGE: >
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/commit-queue.yml
Expand Up @@ -11,7 +11,7 @@ on:
# be read-only, and the Action won't have access to any other repository
# secrets, which it needs to access Jenkins API.
schedule:
- cron: "*/5 * * * *"
- cron: '*/5 * * * *'

env:
NODE_VERSION: lts/*
Expand Down
12 changes: 6 additions & 6 deletions .github/workflows/coverage-linux.yml
Expand Up @@ -5,18 +5,18 @@ on:
types: [opened, synchronize, reopened, ready_for_review]
paths-ignore:
- '**.md'
- 'benchmark/**'
- 'deps/**'
- 'doc/**'
- benchmark/**
- deps/*
- doc/**
- .github/**
- '!.github/workflows/coverage-linux.yml'
push:
branches: [master, main]
paths-ignore:
- '**.md'
- 'benchmark/**'
- 'deps/**'
- 'doc/**'
- benchmark/**
- deps/**
- doc/**
- .github/**
- '!.github/workflows/coverage-linux.yml'

Expand Down
16 changes: 8 additions & 8 deletions .github/workflows/coverage-windows.yml
Expand Up @@ -5,20 +5,20 @@ on:
types: [opened, synchronize, reopened, ready_for_review]
paths-ignore:
- '**.md'
- 'benchmark/**'
- 'deps/**'
- 'doc/**'
- 'tools/**'
- benchmark/**
- deps/**
- doc/**
- tools/**
- .github/**
- '!.github/workflows/coverage-windows.yml'
push:
branches: [master, main]
paths-ignore:
- '**.md'
- 'benchmark/**'
- 'deps/**'
- 'doc/**'
- 'tools/**'
- benchmark/**
- deps/**
- doc/**
- tools/**
- .github/**
- '!.github/workflows/coverage-windows.yml'

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/daily.yml
Expand Up @@ -3,7 +3,7 @@ name: Node.js daily job
on:
workflow_dispatch:
schedule:
- cron: "0 0 * * *"
- cron: 0 0 * * *

env:
NODE_VERSION: lts/*
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/find-inactive-collaborators.yml
Expand Up @@ -3,7 +3,7 @@ name: Find inactive collaborators
on:
schedule:
# Run every Monday at 4:05 AM UTC.
- cron: '5 4 * * 1'
- cron: 5 4 * * 1

workflow_dispatch:

Expand Down Expand Up @@ -37,6 +37,6 @@ jobs:
author: Node.js GitHub Bot <github-bot@iojs.org>
branch: actions/inactive-collaborators
body: This PR was generated by tools/find-inactive-collaborators.yml.
commit-message: "meta: move one or more collaborators to emeritus"
commit-message: 'meta: move one or more collaborators to emeritus'
labels: meta
title: "meta: move one or more collaborators to emeritus"
title: 'meta: move one or more collaborators to emeritus'
6 changes: 3 additions & 3 deletions .github/workflows/find-inactive-tsc.yml
Expand Up @@ -3,7 +3,7 @@ name: Find inactive TSC members
on:
schedule:
# Run every Tuesday 12:05 AM UTC.
- cron: '5 0 * * 2'
- cron: 5 0 * * 2

workflow_dispatch:

Expand Down Expand Up @@ -51,6 +51,6 @@ jobs:
@nodejs/tsc ${{ env.INACTIVE_TSC_HANDLES }}
${{ env.DETAILS_FOR_COMMIT_BODY }}
commit-message: "meta: move one or more TSC members to emeritus"
commit-message: 'meta: move one or more TSC members to emeritus'
labels: meta
title: "meta: move one or more TSC members to emeritus"
title: 'meta: move one or more TSC members to emeritus'
6 changes: 3 additions & 3 deletions .github/workflows/license-builder.yml
Expand Up @@ -3,7 +3,7 @@ on:
schedule:
# 00:00:00 every Monday
# https://crontab.guru/#0_0_*_*_1
- cron: "0 0 * * 1"
- cron: 0 0 * * 1
workflow_dispatch:

jobs:
Expand All @@ -14,14 +14,14 @@ jobs:
- uses: actions/checkout@v2
with:
persist-credentials: false
- run: "./tools/license-builder.sh" # Run the license builder tool
- run: ./tools/license-builder.sh # Run the license builder tool
- uses: gr2m/create-or-update-pull-request-action@v1.x # Create a PR or update the Action's existing PR
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
author: Node.js GitHub Bot <github-bot@iojs.org>
branch: actions/license-builder
title: "doc: run license-builder"
title: 'doc: run license-builder'
body: >
License is likely out of date. This is an automatically generated PR by
the `license-builder.yml` GitHub Action, which runs `license-builder.sh`
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/linters.yml
Expand Up @@ -138,7 +138,7 @@ jobs:
persist-credentials: false
- uses: mszostok/codeowners-validator@v0.6.0
with:
checks: "files,duppatterns"
checks: files,duppatterns
lint-pr-url:
if: ${{ github.event.pull_request }}
runs-on: ubuntu-latest
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/notify-force-push.yml
Expand Up @@ -16,7 +16,7 @@ jobs:
env:
SLACK_COLOR: '#DE512A'
SLACK_ICON: https://github.com/nodejs.png?size=48
SLACK_TITLE: '${{ github.actor }} force-pushed to ${{ github.ref }}'
SLACK_TITLE: ${{ github.actor }} force-pushed to ${{ github.ref }}
SLACK_MESSAGE: |
A commit was force-pushed to <https://github.com/${{ github.repository }}/tree/${{ github.repository.default_branch }}|${{ github.repository }}@${{ github.repository.default_branch }}> by <https://github.com/${{ github.actor }}|${{ github.actor }}>
Expand Down
12 changes: 6 additions & 6 deletions .github/workflows/test-asan.yml
Expand Up @@ -4,10 +4,10 @@ on:
pull_request:
types: [opened, synchronize, reopened, ready_for_review]
paths-ignore:
- '.mailmap'
- .mailmap
- '**.md'
- 'AUTHORS'
- 'doc/**'
- AUTHORS
- doc/**
- .github/**
- '!.github/workflows/test-asan.yml'
push:
Expand All @@ -18,10 +18,10 @@ on:
- v[0-9]+.x-staging
- v[0-9]+.x
paths-ignore:
- '.mailmap'
- .mailmap
- '**.md'
- 'AUTHORS'
- 'doc/**'
- AUTHORS
- doc/**
- .github/**
- '!.github/workflows/test-asan.yml'

Expand Down
12 changes: 6 additions & 6 deletions .github/workflows/test-macos.yml
Expand Up @@ -4,10 +4,10 @@ on:
pull_request:
types: [opened, synchronize, reopened, ready_for_review]
paths-ignore:
- '.mailmap'
- .mailmap
- '**.md'
- 'AUTHORS'
- 'doc/**'
- AUTHORS
- doc/**
- .github/**
- '!.github/workflows/test-macos.yml'
push:
Expand All @@ -18,10 +18,10 @@ on:
- v[0-9]+.x-staging
- v[0-9]+.x
paths-ignore:
- '.mailmap'
- .mailmap
- '**.md'
- 'AUTHORS'
- 'doc/**'
- AUTHORS
- doc/**
- .github/**
- '!.github/workflows/test-macos.yml'

Expand Down
12 changes: 6 additions & 6 deletions .github/workflows/tools.yml
Expand Up @@ -2,7 +2,7 @@ name: Tools update
on:
schedule:
# Run once a week at 00:05 AM UTC on Saturday.
- cron: '5 0 * * 6'
- cron: 5 0 * * 6

workflow_dispatch:

Expand All @@ -23,7 +23,7 @@ jobs:
echo "NEW_VERSION=$NEW_VERSION" >> $GITHUB_ENV
./update-eslint.sh
fi
- id: "lint-md-dependencies"
- id: lint-md-dependencies
run: |
cd tools/lint-md
npm ci
Expand Down Expand Up @@ -63,8 +63,8 @@ jobs:
GITHUB_TOKEN: ${{ secrets.GH_USER_TOKEN }}
with:
author: Node.js GitHub Bot <github-bot@iojs.org>
body: "This is an automated update of ${{ matrix.id }} to ${{ env.NEW_VERSION }}."
branch: "actions/tools-update-${{ matrix.id }}" # Custom branch *just* for this Action.
commit-message: "tools: update ${{ matrix.id }} to ${{ env.NEW_VERSION }}"
body: This is an automated update of ${{ matrix.id }} to ${{ env.NEW_VERSION }}.
branch: actions/tools-update-${{ matrix.id }} # Custom branch *just* for this Action.
commit-message: 'tools: update ${{ matrix.id }} to ${{ env.NEW_VERSION }}'
labels: tools
title: "tools: update ${{ matrix.id }} to ${{ env.NEW_VERSION }}"
title: 'tools: update ${{ matrix.id }} to ${{ env.NEW_VERSION }}'
31 changes: 31 additions & 0 deletions .yamllint.yaml
@@ -1,9 +1,40 @@
extends: default

rules:
braces:
min-spaces-inside: 0
max-spaces-inside: 1
min-spaces-inside-empty: 0
max-spaces-inside-empty: 0

brackets:
min-spaces-inside: 0
max-spaces-inside: 1
min-spaces-inside-empty: 0
max-spaces-inside-empty: 0

comments-indentation:
level: error

document-end:
present: false

document-start:
level: error
present: false

empty-lines:
max: 1

indentation:
spaces: 2

line-length: disable

quoted-strings:
quote-type: single
aduh95 marked this conversation as resolved.
Show resolved Hide resolved
required: only-when-needed

truthy:
allowed-values: ['true', 'false', 'on', 'off']

Expand Down