Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Bump editorconfig-checker/action-editorconfig-checker from 1.0.0 to 2.0.0 #29

Merged
merged 3 commits into from
Sep 25, 2023
Merged

Bump editorconfig-checker/action-editorconfig-checker from 1.0.0 to 2.0.0 #29

merged 3 commits into from
Sep 25, 2023

Commits on Sep 25, 2023

  1. 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](editorconfig-checker/action-editorconfig-checker@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] <support@github.com>
    @dependabot
    dependabot[bot] authored Sep 25, 2023
    Configuration menu
    Copy the full SHA
    a28727a View commit details
    Browse the repository at this point in the history

  2. 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.
    @per1234
    per1234 authored Sep 25, 2023
    Configuration menu
    Copy the full SHA
    cf1070d View commit details
    Browse the repository at this point in the history

  3. Use major version ref of `editorconfig-checker/action-editorconfig-ch… 

    …ecker` 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.
    @per1234
    per1234 authored Sep 25, 2023
    Configuration menu
    Copy the full SHA
    c37fa47 View commit details
    Browse the repository at this point in the history