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.

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

Promoting uses of crate-ci/typos@v1 in examples #1252

Open
muzimuzhi opened this issue Mar 6, 2025 · 2 comments
Open

Promoting uses of crate-ci/typos@v1 in examples #1252

muzimuzhi opened this issue Mar 6, 2025 · 2 comments
Labels
S-triage Status: New; needs maintainer attention.

Comments

@muzimuzhi
Copy link
Contributor

muzimuzhi commented Mar 6, 2025

Description

As there is v1 tag for GitHub Action now (see #1250), maybe it's time to promote uses of uses: crate-ci/typos@v1 instead of the current uses: crate-ci/[email protected] in workflow examples in the docs/github-action.md.

I noticed the pre-release-replacements config field contains a replacement rule for bumping the full version in docs/github-action.md, but I don't know how to get major version from the {{tag_name}} placeholder.

{file="../../docs/github-action.md", search="uses: crate-ci/typos@.*", replace="uses: crate-ci/typos@{{tag_name}}", min=1},

@muzimuzhi muzimuzhi added the S-triage Status: New; needs maintainer attention. label Mar 6, 2025
@epage
Copy link
Collaborator

epage commented Mar 6, 2025

Hmm, unsure which we should advertise by default. We make regular releases that change the dictionary enough that what could be passing today will be failing tomorrow. Having RenovateBot/Dependabot do explicit updates would isolate these to breakages to those PRs, so master is always green.

@muzimuzhi
Copy link
Contributor Author

We make regular releases that change the dictionary enough that what could be passing today will be failing tomorrow.

Oh I didn't think of that before.

Maybe just mention the v1 tag at the end of docs/github-action.md and alert users to the danger described in your last comment?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-triage Status: New; needs maintainer attention.
Projects
None yet
Development

No branches or pull requests

2 participants