New procedure for updating .md and .yaml files #159
Workflow file for this run
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Pull request checks | |
| on: | |
| workflow_dispatch: | |
| pull_request: | |
| branches: | |
| - main | |
| - release/* | |
| jobs: | |
| check-unique-standard-names: | |
| name: Check for duplicates in standard names | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Setup Python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: "3.x" | |
| - name: Install dependencies | |
| run: | | |
| sudo apt-get update | |
| sudo apt-get -y install libxml2-utils | |
| - name: Check for duplicate standard names | |
| run: | | |
| tools/check_xml_unique.py standard_names.xml | |
| check-name-rules: | |
| name: Check standard names against rules | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Setup Python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: "3.x" | |
| - name: Install dependencies | |
| run: | | |
| sudo apt-get update | |
| sudo apt-get -y install libxml2-utils | |
| - name: Checks standard names against character rules | |
| run: | | |
| python3 tools/check_name_rules.py -s standard_names.xml | |
| test-rendering: | |
| name: Test rendering xml file to markdown and yaml | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Setup Python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: "3.x" | |
| - name: Install dependencies | |
| run: | | |
| sudo apt-get update | |
| sudo apt-get -y install libxml2-utils | |
| python -m pip install --upgrade pip | |
| python -m pip install PyYaml | |
| - name: Test rendering xml file to markdown | |
| run: | | |
| # Checks if the saved markdown matches freshly rendered markdown. | |
| # If this fails, prompt user to update | |
| checksum=$(sha256sum Metadata-standard-names.md) | |
| tools/write_standard_name_table.py --output-format md standard_names.xml | |
| test "$checksum" = "$(sha256sum Metadata-standard-names.md)" || exit "Markdown file Metadata-standard-names.md must be updated; see documentation for details" | |
| - name: Test rendering xml file to yaml | |
| run: | | |
| checksum=$(sha256sum Metadata-standard-names.yaml) | |
| tools/write_standard_name_table.py --output-format yaml standard_names.xml | |
| test "$checksum" = "$(sha256sum Metadata-standard-names.yaml)" || exit "YAML file Metadata-standard-names.yaml must be updated; see documentation for details" |