Trigger Slack bot when errors are found in Prismic linting Github action run #11200
+32
−1
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
|
Size Change: 0 B Total Size: 982 kB ℹ️ View Unchanged
|
rcantin-w
changed the title
kenoir
reviewed
Sep 25, 2024
prismic-model/lintPrismicData.ts
Outdated
|
|
||
| // Send an alert to Editors if anything is found on a GitHub Action run | ||
| // https://github.com/wellcomecollection/wellcomecollection.org/actions/workflows/prismic-linting.yml | ||
| if (isGitHubAction && slackWebhookUrl) { |
There was a problem hiding this comment.
As with the other prismic linting PR, could we rely solely on the slackWebhookUrl to signal we should send to slack?
There was a problem hiding this comment.
The webhook url is always the same, and we don't want this to run when we run the report locally for our own testing, so I don't think it applies?
There was a problem hiding this comment.
Hadn't noticed that we're pulling from secrets manager here for SLACK_WEBHOOK_GA_PRISMIC_LINTING_URL , I wonder if either that could be externalised to another GHA step or move the secret retrieval inside the check for isGitHubAction as it is unnecessary otherwise?
Is it useful to pass the webhook URL through an env var here too?
There was a problem hiding this comment.
OK discussed this with @agnesgaroux. We believe that because we already use a GitHub secret in the prismic-linting.yml workflow/action, it makes sense to just move the secret to GitHub so both referenced secrets live in the same space. I'll just confirm it doesn't print it when it passes it to the script, but otherwise it's much simpler.
There was a problem hiding this comment.
Confirmed non printed
Run docker compose run prismic_model yarn lintPrismicData slackWebhookUrl=***
I've scheduled the AWS secret for deletion in 7 days.
agnesgaroux
approved these changes
Sep 25, 2024
kenoir
reviewed
Sep 25, 2024
prismic-model/lintPrismicData.ts
Outdated
| @@ -29,6 +33,13 @@ type ErrorProps = { | |||
| errors: string[]; | |||
| }; | |||
|
|
|||
| const { isGitHubAction } = yargs(process.argv.slice(2)) | |||
There was a problem hiding this comment.
See later comment about removing the need to worry about whether running in GHA or not.
kenoir
approved these changes
Sep 25, 2024
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.
What does this change?
Relates to #11202
Currently, Natalie writes to #wc-editorial when the Prismic linting script reports errors on the dashboard.
This aims to give her one less task every morning!
I've added a webhook workflow that posts this little message when an error or more is found:
I'll be curious to test it against the action itself, but running it locally it seems to work smoothly. See the #bot-test channel in Slack that I've created for stuff like this for all the versions of the bot 😄 The currently still points to it, I'll change that once we're happy and everything is merged, and will tell Editors about it.
How to test
I ran it locally with
yarn lintPrismicData --isGitHubActionand a mock test that I was sure would fail.How can we measure success?
Automated job, happy Natalie!
Have we considered potential risks?
Don't really see any that we couldn't address.