-
Notifications
You must be signed in to change notification settings - Fork 21
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
Refactor GH action workflows #874
Merged
Merged
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
rygine
force-pushed
the
rygine/refactor-gh-actions
branch
from
June 28, 2024 04:03
6f8a38b
to
1168689
Compare
nplasterer
approved these changes
Jun 28, 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.
Summary
build.yml
andrelease.yml
workflowsgithub-pages.yml
todeploy-docs.yml
lint.yml
tolint-workspace.yml
lint-ffi-bindings.yml
) for linting FFI bindings with path filteringtest-ffi-bindings.yml
) for testing FFI bindings with path filteringnoop.yml
) for non-code changesvalidation-server-publish.yml
todeploy-validation-service.yml
For this PR to pass all checks, I'll need to change the required check
lint
toLint
.Notes on path filtering
There are only 2 required checks for pull requests: Lint and Test. This refactoring ensures that these steps are run on every PR. Not every file change will result in linting or testing all code. For example, when only the Node bindings have changes, linting and testing will not run on the FFI bindings (and vice-versa). When only non-code changes occur, linting and testing steps are a no-op.
Unfortunately, we must do this song and dance because if a required check doesn't run as a result of path filtering (
paths
andpaths-ignore
), GitHub doesn't recognize that the check can be skipped.Ignored code paths
The following code directories are currently ignored:
bindings_wasm
: there's nothing of value here yetxmtp_grpc_api_gateway
: this is related tobindings_wasm
xmtp_user_preferences
: AFAIK, this is not currently used in themain
branchNotes on rust tooling
GitHub and Warp action runners come with rust pre-installed. There's no need to use actions to run
rustup
orcargo
.Naming conventions
With these changes, I'm hoping to establish new naming conventions for our GitHub workflow files. We currently deploy, lint, release, and test our code. So I've prefixed the filenames with those actions followed by what part of the code base it's acting on. There's only 1 exception to this:
noop
. Hopefully this exception will go away once GitHub is able to allow skipping of required checks when they don't run as a result of path filtering.Fast follows
There's a very small chance that a deploy or release action doesn't work after these changes. If so, fixing them should be straight-forward.