Update prettier entrypoint.sh to consider dry run #8
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Anu48
force-pushed
the
update-prettier
branch
3 times, most recently
from
80a727f
to
74a9c2d
Compare
Anu48
changed the title
lzm0
reviewed
Apr 24, 2024
prettier/entrypoint.sh
Outdated
Comment on lines
254
to
268
|
|
||
| # case when --write is used with dry-run so if something is unpretty there will always have _git_changed | ||
| if _dry_run; then | ||
| summarize_changes 'Unpretty Files Changes' | ||
| echo "Finishing dry-run. Exiting before committing." | tee -a "$GITHUB_STEP_SUMMARY" | ||
| exit 1 | ||
| fi | ||
|
|
There was a problem hiding this comment.
Since we have two git push in this workflow, I think it makes sense to extract the dry-run check into a function and call it immediately before each git push.
Anu48
force-pushed
the
update-prettier
branch
5 times, most recently
from
2cd4b3e
to
af98583
Compare
jsoref
reviewed
Apr 24, 2024
There was a problem hiding this comment.
build-actions/prettier/action.yml
Line 42 in 9c0188e
Should be changed to clarify that the changes that are made will be included in the github job summary.
prettier/entrypoint.sh
Outdated
Comment on lines
173
to
178
| # case when --write is used with dry-run so if something is unpretty there will always have _git_changed | ||
| if _dry_run; then | ||
| summarize_changes 'Unpretty Files Changes' | ||
| echo "Finishing dry-run. Exiting before committing." | tee -a "$GITHUB_STEP_SUMMARY" | ||
| exit 1 | ||
| fi |
When dry-run is set to true and we use the --write flag, we expect to see what files we'll need to reformat without pushing to remote. However, this requires us to commit the updated changes caused by prettier. Previously, the placement of the dry run logic was done before committing the formatted files, resulting to us not seeing the expected files format. And only using the '--write' flag will not result to a failure even if there are files that requires formatting. By moving the logic after committing the prettier files, it will show us the comparison between two files, without pushing to remote (given that we use dry flag to true).
Anu48
force-pushed
the
update-prettier
branch
2 times, most recently
from
b8ac09f
to
67de674
Compare
jsoref
reviewed
Apr 24, 2024
prettier/action.yml
Outdated
| @@ -39,7 +39,7 @@ inputs: | |||
| required: false | |||
| default: "**" | |||
| dry: | |||
| description: Running the script in dry mode just shows whether there are files that should be prettified or not | |||
| description: Running the script in dry mode just shows whether there are files that should be prettified or not and changes made by prettier will be displayed in github job summary | |||
There was a problem hiding this comment.
Suggested change
| description: Running the script in dry mode just shows whether there are files that should be prettified or not and changes made by prettier will be displayed in github job summary | |
| description: Run prettier in dry-run mode. Display which files are/aren't prettied and changes made by prettier in the GitHub job summary |
jsoref
approved these changes
Apr 24, 2024
jsoref
reviewed
Apr 24, 2024
prettier/action.yml
Outdated
| @@ -39,7 +39,7 @@ inputs: | |||
| required: false | |||
| default: "**" | |||
| dry: | |||
| description: Running the script in dry mode just shows whether there are files that should be prettified or not | |||
| description: Run prettier in dry-run mode. Display which files are/aren't prettied and changes made by prettier in the GitHub job summary | |||
There was a problem hiding this comment.
Suggested change
| description: Run prettier in dry-run mode. Display which files are/aren't prettied and changes made by prettier in the GitHub job summary | |
| description: Run prettier in dry-run mode. Display which files are/aren't pretty and changes made by prettier (to make them pretty) in the GitHub job summary |
lzm0
approved these changes
Apr 24, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When dry-run is set to true and we use the
--writeflag, we expect to see what files we'll need to reformat without pushing to remote. However, this requires us to commit the updated changes caused by prettier. Previously, the placement of the dry run logic was done before committing the formatted files, resulting to us not seeing the expected files format. And only using the '--write' flag will not result to a failure even if there are files that requires formatting.By moving the logic after committing the prettier files, it will show us the comparison between two files, without pushing to remote (given that we use dry flag to true). The dry run will exit with code 1 if there are changes done to the files.
This is the following result using the
--writeflag and dry set to true; when encountering files that need formatting:https://github.com/GarnerCorp/gala-testing/actions/runs/8802209844
Versus when we don't have any files to format:
https://github.com/GarnerCorp/gala-testing/actions/runs/8802264992