ci: debug workflow, rate limit fixes, cleanup #168
Merged
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
Add a debug workflow that makes it easier to figure out what's going wrong in CI. This workflow can only be started manually. It prints some diagnostic info (like current rate limits) and then starts a tmate session. The tmate session lets whoever started the run login into the runner with an an interactive shell. A timeout ensures that the session is eventually terminated.
- Set HOMEBREW_GITHUB_API_TOKEN to tell Homebrew to use our CI token to authenticate with the GitHub API. This drastically increases the rate limit. - Combine the two test jobs into a single matrix job. When installing additional shells, just look at the RUNNER_OS env var to decide whether to use apt or brew. - Install Nix with a single build user to speed up the install time. - Source Nix and set the relevant env vars in the install step so we don't forget to do it in other steps that need Nix. - Run go tests with the race detector and code coverage.
mikeland73
approved these changes
Sep 26, 2022
| run: | | ||
| sudo apt-get update | ||
| sudo apt-get install dash zsh | ||
| if [ "$RUNNER_OS" == "Linux" ]; then |
There was a problem hiding this comment.
You could use if on the steps themselves, might be clearer?
There was a problem hiding this comment.
I went with the env var because I thought it looked weird always seeing a skipped step. If this grows to include more OS-specific commands, then I agree it would be worth splitting up.
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
Update the debug workflow to echo a message with some basic info on how to use tmate. Also rename the job to
debug, put the timeout at the job level, and set a Homebrew GitHub token to help with rate limiting (as described below).The changes in the second commit fix some of the rate limit issues in testa and clean up the job:
How was it tested?
N/A