Add check for uncommitted changes to autogenerated files (#4281)

connorjward · web-flow · commit 302bf2de922f · 2025-05-08T17:06:04.000+01:00
* Remove the unconventional image caching behaviour from team.ini
because the URL is only accessed once.

* Add author photo

* Update AUTHORS.rst and do not autogenerate the citations file
diff --git a/.github/workflows/core.yml b/.github/workflows/core.yml
@@ -106,41 +106,41 @@ jobs:
         # Make sure the current directory is empty
         run: find . -delete
 
+      # Git is needed for actions/checkout and Python for firedrake-configure
+      - name: Install system dependencies (1)
+        run: |
+          apt-get update
+          apt-get -y install git python3
+
       - uses: actions/checkout@v4
         with:
           path: firedrake-repo
           ref: ${{ inputs.source_ref }}
 
-      - name: Install Python
-        run: |
-          apt-get update
-          apt-get -y install python3 python3-venv
-
       - name: Validate single source of truth
         run: ./firedrake-repo/scripts/check-config
 
-      - name: Install system dependencies
-        run: |
-          apt-get -y install \
-            $(python3 ./firedrake-repo/scripts/firedrake-configure --arch ${{ matrix.arch }} --show-system-packages)
-          : # Dependencies needed to run the test suite
-          apt-get -y install parallel
-          : # Dependencies needed to build the documentation
-          apt-get -y install inkscape texlive-full
-
       # Raise an error if any 'TODO RELEASE' comments remain
       - name: Check no 'TODO RELEASE' comments (release only)
         if: inputs.target_branch == 'release'
+        working-directory: firedrake-repo
         run: |
-          cd firedrake-repo
-          if [ -z "$( git grep 'TODO RELEASE' )" ]; then
+          if [ -z "$( grep -r --exclude-dir='.*' 'TODO RELEASE' )" ]; then
             exit 0
           else
             exit 1
           fi
 
-      # TODO: is there a 'blessed commit' or do we just point to 'main'?
-      # I prefer the latter because then failures are everyone's problem, not just mine!
+      - name: Install system dependencies (2)
+        run: |
+          apt-get -y install \
+            $(python3 ./firedrake-repo/scripts/firedrake-configure --arch ${{ matrix.arch }} --show-system-packages)
+          apt-get -y install python3-venv
+          : # Dependencies needed to run the test suite
+          apt-get -y install parallel
+          : # Dependencies needed to build the documentation
+          apt-get -y install inkscape texlive-full
+
       - name: Install PETSc
         run: |
           if [ ${{ inputs.target_branch }} = 'release' ]; then
@@ -398,6 +398,23 @@ jobs:
         if: success() || steps.upload_docs.conclusion == 'success'
         run: echo "conclusion=success" >> "$GITHUB_OUTPUT"
 
+      # Some files are automatically generated when we install or build the
+      # docs (e.g. AUTHORS.rst). These files are committed to the repository
+      # so uncommitted changes at this point reflect changes in the automatically
+      # generated files that ought to be committed.
+      - name: Check no untracked files
+        if: always()
+        working-directory: firedrake-repo
+        run: |
+          if [ -z "$( git status --porcelain )" ]; then
+            exit 0
+          else
+            echo Error: there are untracked files in the repository
+            echo The output from 'git status' is:
+            git status
+            exit 1
+          fi
+
       - name: Post-run cleanup
         if: always()
         run: find . -delete
diff --git a/AUTHORS.rst b/AUTHORS.rst
@@ -80,8 +80,6 @@ Thomas H. Gibson
 
 Tim Greaves
 
-Thomas J. Gregory.............<https://www.imperial.ac.uk/people/t.gregory18>
-
 Alastair Gregory
 
 David A. Ham..................<https://www.imperial.ac.uk/people/david.ham>
diff --git a/Makefile b/Makefile
@@ -39,7 +39,7 @@ actionlint:
 	@docker pull rhysd/actionlint:latest
 	@# Exclude SC2046 so it doesn't complain about unquoted $ characters (the
 	@# quoting can prevent proper parsing)
-	@docker run -e SHELLCHECK_OPTS='--exclude=SC2046,SC2078' --rm -v $$(pwd):/repo --workdir /repo rhysd/actionlint -color
+	@docker run -e SHELLCHECK_OPTS='--exclude=SC2046,SC2078,SC2143' --rm -v $$(pwd):/repo --workdir /repo rhysd/actionlint -color
 
 .PHONY: dockerlint
 dockerlint:
diff --git a/docs/Makefile b/docs/Makefile
@@ -82,7 +82,7 @@ source/element_list.csv: source/element_list.py
 	cd source; python element_list.py
 
 source/team.rst: source/team2.py
-	cd source; python team2.py; mv AUTHORS.rst CITATION.rst ../..
+	cd source; python team2.py; mv AUTHORS.rst ../..
 
 source/firedrake_citations.rst:
 	sphinx-apidoc -f -T -o source/ ../firedrake_citations
diff --git a/docs/source/citation.rst_t b/docs/source/citation.rst_t
diff --git a/docs/source/images/umbertozerbinati.jpg b/docs/source/images/umbertozerbinati.jpg
diff --git a/docs/source/team.ini b/docs/source/team.ini
@@ -32,27 +32,28 @@ Applied Physics Laboratory: https://www.apl.washington.edu/
 
 [active-team]
 # Use format
-# name : personal-webpage, image-link
+# name : personal-webpage
+# Note that if you add your name here you should also add a picture of yourself
+# in /docs/source/images.
 David A. Ham: https://www.imperial.ac.uk/people/david.ham
 Paul H. J. Kelly: https://www.imperial.ac.uk/people/p.kelly
-Lawrence Mitchell: https://www.wence.uk/
 Colin J. Cotter: https://www.imperial.ac.uk/people/colin.cotter
 Robert C. Kirby: https://www.baylor.edu/math/index.php?id=90540
 Koki Sagiyama: https://www.imperial.ac.uk/people/k.sagiyama
-Nacime Bouziani: https://www.imperial.ac.uk/people/n.bouziani18
-Thomas J. Gregory: https://www.imperial.ac.uk/people/t.gregory18
-Jack Betteridge: https://www.imperial.ac.uk/people/j.betteridge, https://avatars.githubusercontent.com/u/43041811
+Jack Betteridge: https://www.imperial.ac.uk/people/j.betteridge
 Daniel R. Shapero: https://psc.apl.uw.edu/people/investigators/daniel-shapero/
-Reuben W. Nixon-Hill: https://www.imperial.ac.uk/people/reuben.nixon-hill10
 Connor J. Ward: https://www.imperial.ac.uk/people/c.ward20
-Patrick E. Farrell: https://pefarrell.org, https://pefarrell.org/images/profile.jpg
-Pablo D. Brubeck: https://www.maths.ox.ac.uk/people/pablo.brubeckmartinez, https://avatars.githubusercontent.com/u/6486130
-India Marsden: https://www.maths.ox.ac.uk/people/india.marsden, https://pefarrell.org/images/marsden.jpg
-Daiane I. Dolci: https://www.imperial.ac.uk/people/d.dolci, https://avatars.githubusercontent.com/u/63597005?v=4
+Patrick E. Farrell: https://pefarrell.org
+Pablo D. Brubeck: https://www.maths.ox.ac.uk/people/pablo.brubeckmartinez
+India Marsden: https://www.maths.ox.ac.uk/people/india.marsden
+Daiane I. Dolci: https://www.imperial.ac.uk/people/d.dolci
 Joshua Hope-Collins: https://www.imperial.ac.uk/people/joshua.hope-collins13
-Umberto Zerbinati: https://www.uzerbinati.eu, https://www.uzerbinati.eu/assets/logo.jpeg
+Umberto Zerbinati: https://www.uzerbinati.eu
 
 [inactive-team]
+Lawrence Mitchell: https://www.wence.uk/
+Reuben W. Nixon-Hill: https://www.imperial.ac.uk/people/reuben.nixon-hill10
+Nacime Bouziani: https://www.imperial.ac.uk/people/n.bouziani18
 Sophia Vorderwuelbecke: https://www.imperial.ac.uk/people/s.vorderwuelbecke18
 Thomas H. Gibson:
 Miklós Homolya:
diff --git a/docs/source/team2.py b/docs/source/team2.py
@@ -39,30 +39,11 @@ def rows(self):
         return range(self.nrows)
 
 
-def cache_web_image(name, url):
-    img_name = "".join(name.split()).lower().encode("punycode").decode()
-    img_name = img_name[:-1] if img_name[-1] == "-" else img_name
-    with urlopen(url) as response:
-        filetype = response.getheader("Content-Type")
-        ext = filetype.split("/")[1]
-        if ext == "jpeg":
-            ext = "jpg"
-        with open("images/" + img_name + "." + ext, "wb") as fh:
-            fh.write(response.read())
-
-
 # Read the current team information from configuration file
 team = ConfigParser(interpolation=ExtendedInterpolation())
 team.optionxform = lambda x: x
 team.read("team.ini")
 
-# Grab images from provided URLs and cahce them (if necessary)
-for name, links in team["active-team"].items():
-    parts = links.split(",")
-    if parts[1:]:
-        website = parts[1]
-        cache_web_image(name, website)
-
 # Environment for applying templates
 env = Environment(
     loader=FileSystemLoader("."),
@@ -105,16 +86,3 @@ def cache_web_image(name, url):
         institution_set=institution_set,
         individual_set=individual_set
     ))
-
-# Create citations file for the Github repository
-citation_rst = env.get_template("citation.rst_t")
-institution_list = [inst[0] for inst in team["dev-institution"].items()]
-institution = ' and '.join(institution_list)
-author_list = list(team['active-team'].keys())
-author_list += list(team['inactive-team'].keys())
-author = ' and '.join(author_list)
-with open("CITATION.rst", "w") as fh:
-    fh.write(citation_rst.render(
-        author=author,
-        institution=institution
-    ))
