Repository navigation
Conversation
Post a Slack message to the APIx DevOps Integrations help usergroup when the go-sdk-validation step fails during an OpenAPI spec release. The step is keyed to steps.go-sdk-validation.outcome, so a failure in an earlier setup step does not notify, and it runs once per incident after the automatic release retries are exhausted.
Correct the duplicate-issue query (an extra brace after the environment made it (dev}) instead of (dev)) and replace the top-level return statements with exit. A run step cannot return, so the step exited 2 and failed the job whenever an open failed-release issue already existed.
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
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.
Proposed changes
Jira ticket: CLOUDP-458828
Adds a Slack notification to
@apix-devops-integrations-helpin#cloud-apix-devops-integrations-notificationswhen thego-sdk-validationstep fails during an OpenAPI spec release, and fixes the release failure handler's duplicate-issue detection.Notification:
Notify the Go SDK validation failurestep inrequired-spec-validations.yml, keyed tosteps.go-sdk-validation.outcome == 'failure'. A failure in an earlier setup step (Node, npm, artifact download, Spectral, Go, SDK checkout) leaves that outcome empty, so setup failures do not notify.github.run_attempt == 3, the release retry cap inrelease-spec.yml), so the extra reruns the retry handler already queued do not duplicate the alert..github/scripts/notify_sdk_validation_failure.shposts the environment, the run URL, and the help usergroup mention. It reports delivery failures and the case where the bot is not in the channel.SLACK_BEARER_TOKENsecret is threaded explicitly throughrelease-spec-runner.ymltorelease-spec.ymltorequired-spec-validations.yml.Failure handler:
(${TARGET_ENV}})became(${TARGET_ENV}).return 0/return 1withexit 0/exit 1. Arun:step cannotreturn, so the step exited 2 and failed the job whenever an openfailed-releaseissue already existed. That is what failed the handler on attempt 4 of run 36420941422.Notes:
actionlintpasses on the changed workflows and the new script parses withbash -n. ShellCheck is not installed locally; theshellcheckworkflow will lint the new script.Checklist
Changes to Spectral
Further comments