From 5de9076f628c0d9275203343592189e29e3b9580 Mon Sep 17 00:00:00 2001 From: scarf Date: Wed, 11 Oct 2023 01:23:53 +0900 Subject: [PATCH] ci: add comment when autofix is invoked (#3395) * ci: add comment when autofix is invoked see: https://github.com/autofix-ci/action/issues/7 * Apply suggestions from code review Co-authored-by: Olanti --------- Co-authored-by: Olanti --- .github/workflows/autofix.yml | 13 ++++++++++++- .../docs/en/mod/json/explanation/json_style.md | 7 ------- 2 files changed, 12 insertions(+), 8 deletions(-) diff --git a/.github/workflows/autofix.yml b/.github/workflows/autofix.yml index 765e2b0d96b6..2eb388f4c7f4 100644 --- a/.github/workflows/autofix.yml +++ b/.github/workflows/autofix.yml @@ -36,7 +36,18 @@ jobs: - name: json formatting run: make style-all-json-parallel RELEASE=1 - - uses: autofix-ci/action@8caa572fd27b0019a65e4c695447089c8d3138b9 + - uses: autofix-ci/action@d3e591514b99d0fca6779455ff8338516663f7cc if: ${{ always() }} with: commit-message: "style(autofix.ci): automated formatting" + commment: | + The Autofix app has automatically formatted this Pull Request. + + If you edit your PR on web UI, you can ignore this message. + If you edit your PR locally, YOU MUST DO EITHER OF THE FOLLOWING: + + - Run `git pull` to merge the automated commit into your local copy of the PR branch. + - [Format your code locally](https://docs.cataclysmbn.org/en/contribute/contributing/#code-style), and force push to your PR branch. + + If you don't do this, your following work will be based on the old commit, and cause MERGE CONFLICT. + diff --git a/doc/src/content/docs/en/mod/json/explanation/json_style.md b/doc/src/content/docs/en/mod/json/explanation/json_style.md index 54457f939b18..a2e26ae01202 100644 --- a/doc/src/content/docs/en/mod/json/explanation/json_style.md +++ b/doc/src/content/docs/en/mod/json/explanation/json_style.md @@ -6,13 +6,6 @@ sidebar: variant: caution --- -:::caution - -[A PR may change current JSON style](https://github.com/cataclysmbnteam/Cataclysm-BN/pull/3118) in -favor of better tooling. - -::: - Like in [C++ Code Style](../../../dev/explanation/code_style.md), the JSON styling policy is to update JSON as it is added or edited, and in relatively small chunks otherwise in order to prevent undue disruption to development.