Skip to content

Add codespell support (config, workflow to detect/not fix) and make it fix some typos#220

Open
yarikoptic wants to merge 6 commits intooras-project:mainfrom
yarikoptic:enh-codespell
Open

Add codespell support (config, workflow to detect/not fix) and make it fix some typos#220
yarikoptic wants to merge 6 commits intooras-project:mainfrom
yarikoptic:enh-codespell

Conversation

@yarikoptic
Copy link
Copy Markdown

More about codespell: https://github.com/codespell-project/codespell .

I personally introduced it to dozens if not hundreds of projects already and so far only positive feedback.

CI workflow has 'permissions' set only to 'read' so also should be safe.

Comment thread examples/README.md
your project, we encourage you to add it to the list here.

- **cloud-select**: this tool [creates a list of custom layers](https://github.com/converged-computing/cloud-select/blob/main/cloud_select/main/cache.py#L81-L107) and content types to store via ORAS and a [custom client](https://github.com/converged-computing/cloud-select/blob/db02c4378f06bfbbe9df6b8a83c885cc9238a04e/cloud_select/main/cache.py#L81).
- **pakages**: uses a [custom client](https://github.com/syspack/pakages/blob/main/pakages/oras.py) to store Spack or pypi (or other artifacts) in GitHub packages.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was correct.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed up for that

Signed-off-by: Yaroslav Halchenko <debian@onerussian.com>
Signed-off-by: Yaroslav Halchenko <debian@onerussian.com>
Signed-off-by: Yaroslav Halchenko <debian@onerussian.com>
…nteractively

=== Do not change lines below ===
{
 "chain": [],
 "cmd": "codespell -w -i 3 -C 4 ./oras/tests/test_oras.py",
 "exit": 0,
 "extra_inputs": [],
 "inputs": [],
 "outputs": [],
 "pwd": "."
}
^^^ Do not change lines above ^^^

Signed-off-by: Yaroslav Halchenko <debian@onerussian.com>
…os automagically

=== Do not change lines below ===
{
 "chain": [],
 "cmd": "codespell -w",
 "exit": 0,
 "extra_inputs": [],
 "inputs": [],
 "outputs": [],
 "pwd": "."
}
^^^ Do not change lines above ^^^

Signed-off-by: Yaroslav Halchenko <debian@onerussian.com>
Signed-off-by: Yaroslav Halchenko <debian@onerussian.com>


1. Start a local registry (described below), or have access to an ORAS [supported registry](https://oras.land/implementors/#docker-distribution)
1. Start a local registry (described below), or have access to an ORAS [supported registry](https://oras.land/docs/compatible_oci_registries)
Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

note -- I entirely replaced 404ing URL

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants