Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Commit

Permalink
Prevent the config-lint script erroring out on any sample_config chan…
Browse files Browse the repository at this point in the history
…ges (#9562)

I noticed that I'd occasionally have `scripts-dev/lint.sh` fail when messing about with config options in my PR. The script calls `scripts-dev/config-lint.sh`, which attempts some validation on the sample config.

 It does this by using `sed` to edit the sample_config, and then seeing if the file changed using `git diff`.

The problem is: if you changed the sample_config as part of your commit, this script will error regardless.

This PR attempts to change the check so that existing, unstaged changes to the sample_config will not cause the script to report an invalid file.
  • Loading branch information
anoadragon453 authored Mar 9, 2021
1 parent 9898470 commit 22db45b
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 2 deletions.
1 change: 1 addition & 0 deletions changelog.d/9562.misc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fix spurious errors reported by the `config-lint.sh` script.
9 changes: 7 additions & 2 deletions scripts-dev/config-lint.sh
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,14 @@
# Find linting errors in Synapse's default config file.
# Exits with 0 if there are no problems, or another code otherwise.

# cd to the root of the repository
cd `dirname $0`/..

# Restore backup of sample config upon script exit
trap "mv docs/sample_config.yaml.bak docs/sample_config.yaml" EXIT

# Fix non-lowercase true/false values
sed -i.bak -E "s/: +True/: true/g; s/: +False/: false/g;" docs/sample_config.yaml
rm docs/sample_config.yaml.bak

# Check if anything changed
git diff --exit-code docs/sample_config.yaml
diff docs/sample_config.yaml docs/sample_config.yaml.bak

0 comments on commit 22db45b

Please sign in to comment.