Skip to content

Normalize adding (and allowing missing) trailing newlines for READMEs. #4524

Normalize adding (and allowing missing) trailing newlines for READMEs.

Normalize adding (and allowing missing) trailing newlines for READMEs. #4524

Workflow file for this run

name: Validate WRITEMEs
# Controls when the action will run.
on: # yamllint disable-line rule:truthy
# Triggers the workflow on push or pull request events but only for the main branch
push:
branches: [main]
pull_request:
branches: [main]
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
# This workflow contains a single job called "build"
build:
name: Validate WRITEMEs
# The type of runner that the job will run on
runs-on: ubuntu-latest
# Steps represent a sequence of tasks that will be executed as part of the job
steps:
- name: Checkout repo content
uses: actions/checkout@v4 # checkout the repository content to github runner.
- name: Setup Python
uses: actions/setup-python@v3
with:
python-version: 3.11 # install the python needed
- name: Install dependencies
run: >-
python3 -m pip install -r .tools/readmes/requirements.txt
- name: Check WRITEMEs
run: >-
python3 .tools/readmes/writeme.py --check --diff