Backport of VAULT-33074: add github
sub-command to pipeline
into release/1.18.x
#29477
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.
Backport
This PR is auto-generated from #29403 to be assessed for backporting due to the inclusion of the label backport/1.18.x.
The below text is copied from the body of the original PR.
Description
Investigating test workflow failures is common task that engineers on the
sustaining rotation perform. This task often requires quite a bit of
manual labor by inspecting all failed/cancelled workflows in the Github UI
on a per repo/branch/workflow basis and performing root cause analysis.
As we work to improve our pipeline discoverability and observability this PR adds a new
github
sub-command to the
pipeline
utility that allows querying for such workflowsand returning either machine readable or human readable summaries in a single
place. Eventually we plan to automate sending a summary of this data to
an OTEL collector automatically, but for now sustaining engineers can
utilize it to query for workflows with lots of various criteria.
A common pattern for investigating build/enos test failure workflows would be:
This will list
build
workflow runs in thehashicorp/vault
repo for themain
branch with thestatus
orconclusion
offailure
within the daterange of
2025-01-13..2025-01-23
.A sustaining engineer will likely do this for both
vault
andvault-enterprise
repositories along withenos-release-testing-oss
andenos-release-testing-ent
workflows in addition tobuild
in order toget a full picture of the last weeks failures.
You can also use this utility to summarize workflows based on other
workflow statuses, a branch name, HEAD SHA, event trigger, github actor, etc. For
a full list of filter arguments you can pass
-h
to the sub-command.Caution
Be careful not to run this without setting strict filter arguments.
Failing to do so could result in trying to summarize way too many
workflows resulting in your API token being disabled for an hour.
TODO only if you're a HashiCorp employee
backport/
label that matches the desired release branch. Note that in the CE repo, the latest release branch will look likebackport/x.x.x
, but older release branches will bebackport/ent/x.x.x+ent
.of a public function, even if that change is in a CE file, double check that
applying the patch for this PR to the ENT repo and running tests doesn't
break any tests. Sometimes ENT only tests rely on public functions in CE
files.
in the PR description, commit message, or branch name.
description. Also, make sure the changelog is in this PR, not in your ENT PR.
Overview of commits