New procedure for updating .md and .yaml files

.github/PULL_REQUEST_TEMPLATE

@@ -15,6 +15,12 @@ Developers listed in the CODEOWNERS file will automatically be assigned to revie
 If your contribution should be reviewed by anyone else, assign those reviewers manually from the
 menu at right, or by tagging them with @USERNAME in the Description text.
 
+Changes to standard names and/or descriptions should be made in the standard_names.xml file. The
+files Metadata-standard-names.md and Metadata-standard-names.yaml will need to be updated before
+a pull request is merged; this can be done manually by the PR author using the script
+tools/write_standard_name_table.py or will be done by the Code Manager prior to merging via Github
+Actions.
+
 Be sure to check in on the PR regularly to respond to comments/questions/reviews!
 --> 
 

.github/workflows/pull_request_ci.yml

@@ -72,14 +72,14 @@ jobs:
 
       - 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
-          echo "The following changes will be committed when this pull request is merged (git diff Metadata-standard-names.md; "
-          echo "assuming that 'Metadata-standard-names.md' wasn't updated and matches the version in the authoritative branch):"
-          git diff Metadata-standard-names.md
+          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
-          echo "The following changes will be committed when this pull request is merged (git diff Metadata-standard-names.yaml; "
-          echo "assuming that 'Metadata-standard-names.yaml' wasn't updated and matches the version in the authoritative branch):"
-          git diff Metadata-standard-names.yaml
+          test "$checksum" = "$(sha256sum Metadata-standard-names.yaml)" || exit "YAML file Metadata-standard-names.yaml must be updated; see documentation for details"

.github/workflows/commit_to_main.yml → .github/workflows/update_md_and_yaml.yml

@@ -1,9 +1,7 @@
 name: Render xml standard name dictionary to markdown and yaml and commit to repository
 
 on:
-  push:
-    branches:
-      - main
+  workflow_dispatch:
 
 jobs:
   update-md-and-yaml:

Metadata-standard-names.md

@@ -1,4 +1,4 @@
-# Earth System Modeling Standard Name Library - add some chunk here to test auto update
+# Earth System Modeling Standard Name Library
 #### Table of Contents
 * [dimensions](#dimensions)
 * [constants](#constants)

Metadata-standard-names.yaml

@@ -1,4 +1,4 @@
-library_name: Earth System Modeling Standard Name Library - add some chunk here to test auto update
+library_name: Earth System Modeling Standard Name Library
 sections:
 - name: dimensions
   comment: 'Dimension standard names may come in sets of six related standard names

README.md

@@ -4,6 +4,6 @@ The Earth System Modeling Standard Names Repository contains community-accepted
 
 Rules governing the designation and format of standard names can be found in [StandardNamesRules.rst](https://github.com/ESCOMP/ESMStandardNames/blob/main/StandardNamesRules.rst) 
 
-A [Markdown file describing the standard names is included](https://github.com/ESCOMP/ESMStandardNames/blob/main/Metadata-standard-names.md), as well as a [Yaml version of the XML file](https://github.com/ESCOMP/ESMStandardNames/blob/main/Metadata-standard-names.yaml).
+A [Markdown file describing the standard names is included](https://github.com/ESCOMP/ESMStandardNames/blob/main/Metadata-standard-names.md), as well as a [YAML version of the XML file](https://github.com/ESCOMP/ESMStandardNames/blob/main/Metadata-standard-names.yaml).
 
-Edits to standard names must be made in the xml file `standard_names.xml` only. When pull requests are merged into the authoritative branch, a tool is run in GitHub actions that automatically updates the human-readable standard name Markdown file and the Yaml version.
+Edits to standard names must be made in the xml file `standard_names.xml` only. When a pull request is opened into the main branch, the YAML and Markdown files should be updated using the `tools/write_standard_name_table.py` script. This can be done manually by the pull request author, or by activating the GitHub action available on an open pull request.