New works-for-everything CI #2365
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
This version of the test workflow can be pasted without changes into any repo whose tests don't have additional dependencies and don't need to separately test that they're still Vapor-compatible (such as console-kit). Improvements over existing CI: - Runs on pushes to master as well as PRs - Full coverage of all available Swift runner images for Linux - Uses latest Xcode without hardcoding on macOS - Nice names for each test step - Nice name for the workflow itself
MrLotU
approved these changes
May 26, 2020
gwynne
commented
May 26, 2020
gwynne
commented
May 26, 2020
tanner0101
approved these changes
May 26, 2020
nachoBonafonte
pushed a commit
to scope-demo/vapor
that referenced
this pull request
May 27, 2020
* New works-for-everything CI (vapor#2365) * New works-for-everything CI This version of the test workflow can be pasted without changes into any repo whose tests don't have additional dependencies and don't need to separately test that they're still Vapor-compatible (such as console-kit). Improvements over existing CI: - Runs on pushes to master as well as PRs - Full coverage of all available Swift runner images for Linux - Uses latest Xcode without hardcoding on macOS - Nice names for each test step - Nice name for the workflow itself * Apply suggestions from code review * `Environment` cleanups (vapor#2353) * Remove numerous unnecessary code stanzas. * Don't check `isRelease` in `Environment.==`, it will always be equal because the value is effectively a compile-time constant. Also improve the use of MARK comments so Xcode renders the intended divisions nicely. * Add warning to `Environment.isRelease` explaining the seemingly unusual behavior of its value. * Redo the documentation comments for `Environment.secret()` (both versions). Significantly simplify the implementation of the path-taking version. IMPORTANT NOTE: This is an interim step of cleanup while a much more complete revamping of this API is worked on. * Correctly sanitize the excess arguments Xcode passes to test invocations for the testing environment. I forgot to mention in a previous commit that support was added for `VAPOR_ENV` too... * Add sanitization of raw SwiftPM's invocation of the xctest runner binary. This is necessarily a little specific to the version of SwiftPM and Xcode involved, but should at least be specific enough a check to not interfere with normal operations if the call sequence changes. * There is no need to hardcode all the logger levels for `LosslessStringConvertible` conformance. `Logger.Level` is already `RawRepresentable` as `String` and that conformance can be used transparently. (And it has `CaseIterable` for good measure, which provides yet another way to scale this particular elevation.) Co-authored-by: Gwynne Raskind <gwynne@darkrainfall.org>
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.
This version of the test workflow is designed to be pasted unchanged into any repo whose tests don't have additional dependencies (such as
fluent-kit) and don't need to separately test compatibility with Vapor (such asconsole-kit).Carries these improvements over the existing CI that was in use for this repo:
Affects CI only, no semver label attached.
Hopefully there's a way to do two important things that would make this much nicer (above and beyond the improvements already given):
If we could get GitHub to read an entire workflow from an external repository ("actions" don't suffice for this), it would be very nice to be able to have just the needed three versions of this workflow in a
vapor-cirepo that would apply to every other repo at once so we wouldn't have to keep updating them one at a time as more innovations are added.In the same vein, it would be nice if the list of Swift runner images wasn't static, so that the addition of new runner images also didn't necessitate rolling out updates across all the repos.
It's not clear that GitHub's workflows are capable of either of these levels of abstraction - in fact there are strong suggestions that it not only isn't, but doesn't even want to be. That's never stopped me before, of course, but there's also a limit to the time that should be spent on such things. If anyone has suggestions for how to make these happen, please share!