-
Notifications
You must be signed in to change notification settings - Fork 25
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
Reduce configuration burden #20
Comments
The readme.md isn't strictly necessary and could be removed. I believe I have the same information in this repository. If there's a specific path in this repository, I'm quite happy to make adjustments. |
With v0.0.20, you can now onboard with a single file: With that configuration, defaults are pulled in from check-spelling/spell-check-this. It's not quite the same as not maintaining files, since it's only temporary. But, I think I could extend it so that it could pull in any files that aren't overridden, instead of only using it for bootstrapping. I created a sample repository that uses it (you can tell it did something because otherwise the run would have complained about the |
Thinking more about the If I moved the contents of: Into How does that sound? I think for the other items, to support minimization, I'll need to think about how to handle "inherit" vs "supplement" vs "replace". Right now spell-check-this works as a backstop for when you have nothing, but once you start configuring things, you stop using it. One of the reasons for this model is that I don't want people's instances to break if I add/remove entries from the upstream. I could adjust this by letting them point to a SHA instead of a floating branch/tag, but that's at least one consideration. The other side is: if a project does choose to use a baseline but for a certain file decides it wants to replace it instead of supplementing it, how would I let them declare that? @ricardo-dematos do you have any thoughts? |
Sorry, but I can't understand the purpose of this... 🤔
I think that check-spelling/spell-check-this should be something like valispace/actions/check-spelling, where I'm trying to achieve a common configuration to use across Valispace repos. checkspelling/spell-check-this could be used directly in uses: check-spelling/[email protected]
with:
spell_check_this: 'check-spelling/[email protected]' or it could be used as a template repository, where each one would configure its uses: check-spelling/[email protected]
with:
spell_check_this: 'valispace/actions/spell-check-this@master' I'm struggling to define the correct |
Check Spelling was recently onboarded to github.com/aws/karpenter. This a great addition, but it comes with a concern of complexity and maintainability. The PR includes 622 lines of code to enable the checker: https://github.com/aws/karpenter/pull/1057/files. Ideally it would be ~100 lines of code to onboard.
In general, I'd like to be able to onboard to check spelling w/ something as simple as:
This could potentially look like:
I'd also prefer to not include the README in my .workflows folder, and instead rely on going to https://github.com/check-spelling/check-spelling.
The text was updated successfully, but these errors were encountered: