search

reviewdog / action-remark-lint

Run remark-lint with Reviewdog :dog:
https://github.com/reviewdog/reviewdog
MIT License
5 stars 9 forks source link

BREAKING CHANGE: Migrates action to composite action #57

Closed rickstaa closed 3 years ago

rickstaa commented 3 years ago

This pull request migrates the GitHub action to a composite action, this was done to make it easier for users to install remark-lint presets.

rickstaa commented 3 years ago

@asbjornu Since to my knowledge a composite action should not magically do things, I added the install_deps flag. Please let me know if you think that is a good solution?

rickstaa commented 3 years ago

@asbjornu Since to my knowledge a composite action should not magically do things, I added the install_deps flag. Please let me know if you think that is a good solution?

As I expect most people who use remark-lint plugins to have a package.json file and the need to install dependencies, perhaps the flag can be set to true by default? Since that's how the action already works, it will also preserve backwards compatibility.

I have no problem with changing the default given it increases backwards compatibility.

rickstaa commented 3 years ago

@asbjornu I pushed the changes you requested. Let me know if you see other things that need to change. If not, I will rebase and merge this pull request after you approved #55.

rickstaa commented 3 years ago

@asbjornu No problem. It is a new kind of action introduced on 25 aug (see https://github.blog/changelog/2021-08-25-github-actions-reduce-duplication-with-action-composition/) that allows you to reference other actions inside actions. By doing this, all the code runs in the main container.

asbjornu commented 3 years ago

@rickstaa, aha! That looks quite brilliant!

github-actions[bot] commented 3 years ago

🏷️ [bumpr] Next version:v5.0.0 Changes:v4.1.0...reviewdog:migrate_to_composite_action

github-actions[bot] commented 3 years ago

🚀 [bumpr] Bumped! New version:v5.0.0 Changes:v4.1.0...v5.0.0