Github action for cargo-spellcheck

[drahnr]

Github action for cargo-spellcheck

[mickare]

Hey, I just wrote an action: https://github.com/mickare/cargo-spellcheck-action

I'm not an expert with Github Actions, and I'm sure this can be improved. When a Dockerfile is used, Github Actions seem to rebuild on each run the Docker Image; which takes ~ 8m to complete for cargo-spellcheck. A pre-build image on hub.docker.com reduced it down to 40s.

So I propose that this project adds an "official" Dockerfile / Docker Image.

[drahnr]

To make it viable for CI, I think this has a soft dependency on #12 and #10 - otherwise a lot of topic lingo would show up which certainly will cause some friction.

Do you have any resource links how to write a github resource?

[drahnr]

The relevant documentation for creating a docker based github action https://docs.github.com/en/actions/creating-actions/creating-a-docker-container-action

[drahnr]

I am a big fan of mono-repos. It avoids a lot of chores with synchronization.

The above issue would indeed make sense for the sake of the github action.

Let me think about this.

[drahnr]

@EdJoPaTo could you open a new issue outlining if there are any changes required?

[stanislav-tkach]

Unfortunately, I don't have experience with writing github actions.

#10 doesn't look like a blocker to me, but #12 does.

By the way, currently I'm using cspell on CI, but I would prefer to use a Rust tool. Additionally, using cargo spellcheck locally is definitely more convenient.

[drahnr]

@mickare Would you be ok if I integrate your repo as a sub dir? Could you create a PR with a subdir "ci/github-action" with the content of your repository?

Very very much appreciated!

[mickare]

@drahnr Ok, let me try. But a quick remark: It seems like Github Actions must be defined in the top level of a repository via the file action.yml.

https://docs.github.com/en/actions/creating-actions/publishing-actions-in-github-marketplace#about-publishing-actions
The action's metadata file (action.yml or action.yaml) must be in the root directory of the repository.

[drahnr]

Then let's do that.

[Robbepop]

Maybe it is better to form a GitHub organization around cargo-spellcheck and have the GitHub Action as its own repo within the org?

[mickare]

I found a good example for a single repository action: https://github.com/github/super-linter
On the downside, it means that each time a new tag/release is created, the Docker version must be updated manually
(until someday Github adds a feature).

On the other hand an extra Github Action git repository could be automatically updated by a workflow script in this repo. Triggered by a new release, it could update the version of the Docker Image in the action.yml and then tag it accordingly.
Although I don't favor this one, it seems to be the Docker-way of doing things.

I have a last idea which is a mono-repo solution. But I have to check it first.

[drahnr]

I found a good example for a single repository action: https://github.com/github/super-linter
On the downside, it means that each time a new tag/release is created, the Docker version must be updated manually
(until someday Github adds a feature).

On the other hand an extra Github Action git repository could be automatically updated by a workflow script in this repo. Triggered by a new release, it could update the version of the Docker Image in the action.yml and then tag it accordingly.
Although I don't favor this one, it seems to be the Docker-way of doing things.

I have a last idea which is a mono-repo solution. But I have to check it first.

I have existing CI infrastructure, so anything is possible that involves input from gh and output to a container registry.

[EdJoPaTo]

It might be a good idea to support cargo-binstall then everything and everyone like users, CI and so on with cargo-binstall can just install cargo-spellcheck. No custom github action for every tool needed, just common ones for cargo-binstall which then install the tooling.