From a28727a11a2aaddc7afb068c4ae3c0a33c265bb0 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 25 Sep 2023 07:43:50 +0000 Subject: [PATCH 1/3] Bump editorconfig-checker/action-editorconfig-checker Bumps [editorconfig-checker/action-editorconfig-checker](https://github.com/editorconfig-checker/action-editorconfig-checker) from 1.0.0 to 2.0.0. - [Release notes](https://github.com/editorconfig-checker/action-editorconfig-checker/releases) - [Commits](https://github.com/editorconfig-checker/action-editorconfig-checker/compare/v1.0.0...v2.0.0) --- updated-dependencies: - dependency-name: editorconfig-checker/action-editorconfig-checker dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] --- .github/workflows/check-general-formatting.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/check-general-formatting.yml b/.github/workflows/check-general-formatting.yml index daf0142..3d29e71 100644 --- a/.github/workflows/check-general-formatting.yml +++ b/.github/workflows/check-general-formatting.yml @@ -19,4 +19,4 @@ jobs: uses: actions/checkout@v4 - name: Check formatting - uses: editorconfig-checker/action-editorconfig-checker@v1.0.0 + uses: editorconfig-checker/action-editorconfig-checker@v2.0.0 From cf1070d389138deae9c56c7b3ffd248f978c34ad Mon Sep 17 00:00:00 2001 From: per1234 Date: Mon, 25 Sep 2023 12:11:41 -0700 Subject: [PATCH 2/3] Add editorconfig-checker invocation step to workflow The editorconfig-checker/action-editorconfig-checker action is used in the "Check General Formatting" GitHub Actions workflow. The behavior of that action changed starting from the 2.0.0 release. Previously it ran editorconfig-checker on the files in the workspace. The action now solely serves to make editorconfig-checker available in the runner machine for use in subsequent steps of the job (equivalent to the various popular "setup-*" actions for other frameworks/languages/tools). This means it is now necessary to add a new step to the workflow to actually invoke editorconfig-checker. --- .github/workflows/check-general-formatting.yml | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/.github/workflows/check-general-formatting.yml b/.github/workflows/check-general-formatting.yml index 3d29e71..b68ab32 100644 --- a/.github/workflows/check-general-formatting.yml +++ b/.github/workflows/check-general-formatting.yml @@ -18,5 +18,8 @@ jobs: - name: Checkout repository uses: actions/checkout@v4 - - name: Check formatting + - name: Install editorconfig-checker uses: editorconfig-checker/action-editorconfig-checker@v2.0.0 + + - name: Check formatting + run: editorconfig-checker From c37fa476600f3a686a1eabb1d822c5552dbc1229 Mon Sep 17 00:00:00 2001 From: per1234 Date: Mon, 25 Sep 2023 12:12:44 -0700 Subject: [PATCH 3/3] Use major version ref of `editorconfig-checker/action-editorconfig-checker` action The editorconfig-checker/action-editorconfig-checker action is used in the "Check General Formatting" GitHub Actions workflow as a convenient way to install the editorconfig-checker tool. A major version ref is provided by the maintainers of that repository. It will always point to the latest release of the 2.x major version series. Use of the major version ref will cause the workflow to use a stable version of the action, while also benefiting from ongoing development to the action up until such time as a new major release of an action is made. At that time we would need to evaluate whether any changes to the workflow are required by the breaking change that triggered the major release before manually updating the major ref (e.g., `uses: editorconfig-checker/action-editorconfig-checker@v2` -> `uses: editorconfig-checker/action-editorconfig-checker@v3`). I think this major version ref approach to action dependency management strikes the right balance between stability and maintainability for this type of workflow. --- .github/workflows/check-general-formatting.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/check-general-formatting.yml b/.github/workflows/check-general-formatting.yml index b68ab32..77d778f 100644 --- a/.github/workflows/check-general-formatting.yml +++ b/.github/workflows/check-general-formatting.yml @@ -19,7 +19,7 @@ jobs: uses: actions/checkout@v4 - name: Install editorconfig-checker - uses: editorconfig-checker/action-editorconfig-checker@v2.0.0 + uses: editorconfig-checker/action-editorconfig-checker@v2 - name: Check formatting run: editorconfig-checker