Skip to content
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

Updates documentation #31

Merged
merged 18 commits into from
Jan 10, 2021
Merged

Updates documentation #31

merged 18 commits into from
Jan 10, 2021

Conversation

rickstaa
Copy link
Member

@rickstaa rickstaa commented Jan 7, 2021

This pull request is a response on #25. In this pull request, I added a format feature to the repository. After a discussion, @haya14busa and I decided that this feature should be in a seperate repository. I, therefore, removed the formatting related changes and kept the rest of the changes. This results in the following features.

✨ Main changes

  • Better gh-action tests.
  • Updates action documentation.

💥 Breaking changes

  • I changed the dash shell to the bash shell into the docker container. This allows us to both catches the errors and have cleaner code. This doesn't change the docker size by much.
  • I changed the black_flags input argument to black_args as we can also pass non-flag arguments like file paths.

This commit adds one big feature and several small fixes.

Features:
 - Adds formatting support

Small changes:
 - Shell was changed from dash to bash
 - The remark_flags argument was replaced with the often used args
 argument.
The linting and formatting steps are now seperated such that the
formatting output does not get passed to the reviewdog error parser.
@rickstaa rickstaa requested a review from haya14busa January 7, 2021 20:15
@rickstaa rickstaa mentioned this pull request Jan 7, 2021
@rickstaa
Copy link
Member Author

rickstaa commented Jan 8, 2021

@haya14busa, @limakzi Thanks for all the suggestions. Based on your comments, I realized that the error catching behaviour is not needed anymore if we do not add the formatting feature. Therefore, I trimmed down the code, and it is now very close to the original code on the master branch. The features that are now included are:

✨ Features

  • The documentation was updated.
  • The action now also works when people incorrectly capitalize input arguments (e.g. TRUE instead of true).
  • The action now also works with args.

💥 Breaking changes

  • I changed the dash shell to the bash shell into the docker container. This allows for cleaner code. The docker size doesn't change much.

I think both features are not really required, but I added them when creating the auto-format feature. We can therefore also remove these features, keep the original implementation (dash shell, without dev args and strict input arg checking) and only keep the updated documentation. Let me know what you think.

@rickstaa rickstaa requested review from haya14busa and limakzi January 8, 2021 12:40
@rickstaa rickstaa changed the title Adds better error catch behavoir Updates documentation Jan 8, 2021
@rickstaa
Copy link
Member Author

rickstaa commented Jan 8, 2021

🧪 Additional (succesfull) test results can be found rickstaa/action-test-repo#52.

This commit removes the ability to supply input arguments. This was
added for debuggin purposes but is not needed as during debugger we can
just export the variables as environmental variables.
This commit fixes some bugs in the Dockerfile and entrypoint files.
These bugs were pointed out by handolint on
#31.
@rickstaa rickstaa added bump:minor Bump the minor version on pull request bump:major Bump the major version on pull request and removed bump:minor Bump the minor version on pull request labels Jan 10, 2021
@github-actions
Copy link
Contributor

🏷️ [bumpr] Next version:v1.1.0 Changes:v1.0.3...reviewdog:add_formatting_option

@github-actions
Copy link
Contributor

🏷️ [bumpr] Next version:v2.0.0 Changes:v1.0.3...reviewdog:add_formatting_option

@rickstaa rickstaa merged commit 67b6b60 into master Jan 10, 2021
@rickstaa rickstaa deleted the add_formatting_option branch January 10, 2021 13:35
@github-actions
Copy link
Contributor

🚀 [bumpr] Bumped! New version:v2.0.0 Changes:v1.0.3...v2.0.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bump:major Bump the major version on pull request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants