chore: New manual GitHub Action to diff bundled outputs #2489
Conversation
This file contains hidden or 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
Deploying atlantis with
|
| Latest commit: |
530a38f
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://7aa866f3.atlantis.pages.dev |
| Branch Preview URL: | https://cleanup-git-diff-action.atlantis.pages.dev |
jdeichert
force-pushed
the
CLEANUP/git-diff-action
branch
from
51060f2 to
be99164
Compare
jdeichert
changed the title
jdeichert
commented
Apr 16, 2025
| @@ -0,0 +1,69 @@ | |||
| name: Diff Outputs | |||
|
|
|||
| on: workflow_dispatch | |||
There was a problem hiding this comment.
This is a manual action because we don't need to run it on every PR. It'll show up here after this merges: https://github.com/GetJobber/atlantis/actions
Aiden-Brine
reviewed
Apr 16, 2025
|
|
||
| # Unignore dist directories and stage them to commit later | ||
| sed -i '/\<dist\>/d' .gitignore | ||
| git add -A |
There was a problem hiding this comment.
I think we should force add them with -f instead of modifying the .gitignore file
Aiden-Brine
reviewed
Apr 17, 2025
| git config --global user.email "[email protected]" | ||
|
|
||
| - name: Check for differences in built assets | ||
| run: | |
There was a problem hiding this comment.
How about having set -e at the top of the script so that if something like npm ci fails it will exit out quickly?
Aiden-Brine
reviewed
Apr 17, 2025
|
|
||
| - name: Check for differences in built assets | ||
| run: | | ||
| clean_dist() { |
There was a problem hiding this comment.
I'm also wondering if it would be more readable if this was broken up into more name/run commands? You have lots of echo statements so it is still fairly easy to follow and I feel less strongly about this one.
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.
Motivations
This PR adds a new manually-triggered GitHub Action that diffs the outputs of our packages on a given branch.
If you're testing a PR... let's say a dependabot version bump of some dependency... and you're not sure whether it's safe to ship because it could affect the final built assets that we ship, THIS ACTION IS FOR YOU!
Simply run this GH Action against your branch and you'll see one of two things:
✅ No differences found in built assets!
OR
👉 Please investigate the differences above to see if they are expected.
If you see the latter warning, look above it and you'll see a git diff showing what exactly changed. Usually it will be something within a
distdirectory in one of the packages. Just review the diff to see if it makes sense and whether it's safe to ship OR if you need to do more testing, then do that!Changes
Added
Testing
No need to test, I ran this on this PR a few times.
When there's no changes
https://github.com/GetJobber/atlantis/actions/runs/14503388190
When there are changes
https://github.com/GetJobber/atlantis/actions/runs/14503583543/job/40688621884
Changes can be tested via Pre-release