diff-check: introduce a required language_edition input

When a language edition is not specified, `rustfmt` will default to
Edition 2015 (like `rustc`), which tends to cause parse errors in the
preset set of candidate projects being used for comparison.

Introduce a required `language_edition` input for the Diff Check
workflow (and the `check_diff.sh` script) so that the contributor
invoking the workflow is much less likely to miss specifying the
language edition. Like the previous `style_edition` input, the language
edition can also be overriden by `edition=...` settings in the later
optional `rustfmt_configs` input for consistency.

Author: jieyouxu

.github/workflows/check_diff.yml

@@ -8,6 +8,9 @@ on:
       branch_name:
         description: 'Name of the feature branch on the forked repo'
         required: true
+      language_edition:
+        description: 'Language edition to run both rustfmt with; can be overridden by language edition settings in `rustfmt_configs`'
+        required: true
       style_edition:
         description: 'Style edition to run both rustfmt with; can be overridden by style edition settings in `rustfmt_configs`'
         required: true
@@ -33,4 +36,4 @@ jobs:
         rustup target add x86_64-unknown-linux-gnu
 
     - name: check diff
-      run: bash ${GITHUB_WORKSPACE}/ci/check_diff.sh ${{ github.event.inputs.clone_url }} ${{ github.event.inputs.branch_name }} ${{ github.events.inputs.style_edition }} ${{ github.event.inputs.commit_hash || github.event.inputs.branch_name }} ${{ github.event.inputs.rustfmt_configs }}
+      run: bash ${GITHUB_WORKSPACE}/ci/check_diff.sh ${{ github.event.inputs.clone_url }} ${{ github.event.inputs.branch_name }} ${{ github.events.inputs.language_edition }} ${{ github.events.inputs.style_edition }} ${{ github.event.inputs.commit_hash || github.event.inputs.branch_name }} ${{ github.event.inputs.rustfmt_configs }}

ci/check_diff.sh

@@ -3,7 +3,7 @@
 set -e
 
 function print_usage() {
-    echo "usage check_diff REMOTE_REPO FEATURE_BRANCH STYLE_EDITION [COMMIT_HASH] [OPTIONAL_RUSTFMT_CONFIGS]"
+    echo "usage check_diff REMOTE_REPO FEATURE_BRANCH LANGUAGE_EDITION STYLE_EDITION [COMMIT_HASH] [OPTIONAL_RUSTFMT_CONFIGS]"
 }
 
 if [ $# -le 1 ]; then
@@ -13,12 +13,17 @@ fi
 
 REMOTE_REPO=$1
 FEATURE_BRANCH=$2
-# Can still be overridden by style edition configuration in `OPTIONAL_RUSTFMT_CONFIGS`. This is a
-# separate arg mostly to make sure it's not forgotten when manually dispatching the Diff Check
+
+# Required language edition and style edition inputs.
+#
+# Can still be overridden by style edition configuration in `OPTIONAL_RUSTFMT_CONFIGS`. They are
+# separate arg mostly to make sure they are not forgotten when manually dispatching the Diff Check
 # workflow.
-STYLE_EDITION=$3
-OPTIONAL_COMMIT_HASH=$4
-OPTIONAL_RUSTFMT_CONFIGS=$5
+LANGUAGE_EDITION=$3
+STYLE_EDITION=$4
+
+OPTIONAL_COMMIT_HASH=$5
+OPTIONAL_RUSTFMT_CONFIGS=$6
 
 # OUTPUT array used to collect all the status of running diffs on various repos
 STATUSES=()
@@ -48,13 +53,22 @@ function init_submodules() {
 # $3: Any additional configuration options to pass to rustfmt
 #
 # Globals:
+# $LANGUAGE_EDITION: Language edition. When not specified, `rustfmt` (like
+#     `rustc`) will default to Edition 2015, which for the projects being
+#     compared will likely cause parse errors since they tend to be on
+#     Edition 2024 (or later). Can still be override by language edition
+#     specified in `$OPTIONAL_RUSTFMT_CONFIGS`.
 # $STYLE_EDITION: Style edition; can be overridden by style edition specified in
 #     `$OPTIONAL_RUSTFMT_CONFIGS`.
 # $OPTIONAL_RUSTFMT_CONFIGS: Optional configs passed to the script
 function create_diff() {
     local config;
     # Unconditionally set
     config="--config=error_on_line_overflow=false,error_on_unformatted=false"
+    # Can still be overridden by later `edition` configurations in
+    # `$OPTIONAL_RUSTFMT_CONFIGS`.
+    config="$config,edition=$LANGUAGE_EDITION"
+
     # Can still be overridden by later `style_edition` configurations in
     # `$OPTIONAL_RUSTFMT_CONFIGS`.
     config="$config,style_edition=$STYLE_EDITION"
@@ -201,6 +215,8 @@ function log_inputs() {
     echo "$REMOTE_REPO"
     echo "Feature branch:"
     echo "$FEATURE_BRANCH"
+    echo "Language edition:"
+    echo "$LANGUAGE_EDITION"
     echo "Style edition:"
     echo "$STYLE_EDITION"
     echo "(Optional) Commit hash:"