Skip to content

No documentation for running on github actions #2565

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

Closed
ssbarnea opened this issue Apr 27, 2021 · 3 comments
Closed

No documentation for running on github actions #2565

ssbarnea opened this issue Apr 27, 2021 · 3 comments

Comments

@ssbarnea
Copy link

The documentation page from https://commitlint.js.org/#/guides-ci-setup does include guides only for Travis and Circle CI but fails to document how to setup Github Actions, a CI that is likely more popular than all others combined.

I was able to identify at least 3 different third party github actions on https://github.com/marketplace?query=commitlint but I do think that documenting a more or less official/recommended way of implementing the CI part would be highly useful for others.

Commitlint is great but we also need CI executions in order to avoid accidents.

While I will try to use the action with most stars and report back, I think that the maintainers should be able to state which approach they would recommend.

@escapedcat
Copy link
Member

Hey @ssbarnea , is this a duplicate of #586 ?
If yes, you might find some useful information as well.
We're happy for any help we can get regarding this topic.

@ssbarnea
Copy link
Author

Sadly it missed my initial search for existing tickets. I will add my text as a comment and close this one.

As I cannot edit the main ticket title/body, you maybe could edit it to make it more broad: in the end we need a documentation and example on how to use it with github actions. If there is a command line for it or not, that's is implementation detail IMHO, not really a feature by itself.

@escapedcat
Copy link
Member

Thanks for your feedback. No quite sure what title would be better. Happy for a suggestion though!

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

No branches or pull requests

2 participants