Removed unused build.yml and release.yml workflows
Renamed github-pages.yml to deploy-docs.yml
Updated workspace linting workflow
Renamed lint.yml to lint-workspace.yml
Added path filtering
Removed FFI bindings linting
Added new workflow (lint-ffi-bindings.yml) for linting FFI bindings with path filtering
Updated workspace test workflow
Added path filtering
Removed FFI bindings testing
Added new workflow (test-ffi-bindings.yml) for testing FFI bindings with path filtering
Added new workflow (noop.yml) for non-code changes
Updated validation server deployment workflow
Renamed validation-server-publish.yml to deploy-validation-service.yml
Added ability to manually deploy via workflow dispatch
Updated all runners to use the fastest machines available when applicable
Removed use of outdated or deprecated actions
Upgraded all actions to their latest version
Ensured that the rust toolchains are updated and targets added before restoring cache (see top comment on the example for more details)
For this PR to pass all checks, I'll need to change the required check lint to Lint.
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 and paths-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 yet
xmtp_grpc_api_gateway: this is related to bindings_wasm
xmtp_user_preferences: AFAIK, this is not currently used in the main branch
Notes on rust tooling
GitHub and Warp action runners come with rust pre-installed. There's no need to use actions to run rustup or cargo.
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.
Summary
build.ymlandrelease.ymlworkflowsgithub-pages.ymltodeploy-docs.ymllint.ymltolint-workspace.ymllint-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.ymltodeploy-validation-service.ymlFor this PR to pass all checks, I'll need to change the required check
linttoLint.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 (
pathsandpaths-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_wasmxmtp_user_preferences: AFAIK, this is not currently used in themainbranchNotes on rust tooling
GitHub and Warp action runners come with rust pre-installed. There's no need to use actions to run
rustuporcargo.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.