Repository navigation
Releases
v0.1.3
uses: github.com/mozership/probe-slack@3f5ae62b66e08a1f98d350a5ab0aff6717a5f262 # v0.1.3A release of the README: probe guide github.com/mozership/probe-slack prints the README of the latest release, from Probe v1.34.0 on, and this one says all that the page of the action in the Probe docs says.
Highlights
- The README says what the page in the Probe docs says, with links into the docs written in full. See mozership/probe#514.
Changelog
v0.1.2
uses: github.com/mozership/probe-slack@b4470dd28860e43f48f61e9bcf51b960b2c2c5ff # v0.1.2A fix release: the action is built with Probe v1.33.3, which reads the tables of GitHub Flavored Markdown in finding the code of a note.
Highlights
- A
<secret:NAME>or<redacted>between the backticks of two cells of a table row, as in| `x | <redacted> | y` | z |, is now put in code, as<redacted>, so that Slack shows it rather than taking it for a link or a mention. v0.1.1 took it for code, as a paragraph would have it, though a table cuts its row into cells before reading code spans. - A placeholder in a code span within one cell is left as it is, as before, and a
|in its name is escaped so that it does not end the cell.
Changelog
v0.1.1
uses: github.com/mozership/probe-slack@06717bb03b81a793fa2276d2837ef881e52e093c # v0.1.1A fix release: the placeholders of hidden values are now put in code where Slack would take them for a link or a mention, in cases v0.1.0 got wrong. The action now reads the notes and escapes them with Probe v1.33.0.
Highlights
- A job or step name that starts with four spaces, or a title that starts with
```, was escaped as code by itself, so its<secret:NAME>or<redacted>was left as it was in the line that shows it. A name is now escaped in that line. - The code of a note is found with a CommonMark parser, so a fence in a quote, and a paragraph that a heading or a list item ends, are read as Markdown reads them.
- The code span around a placeholder uses the shortest run of backticks the text does not have, so it stays short beside a long run.
- A field of a note of the wrong type is told by its type in the error, not by its value, which could hold a secret.
Changelog
v0.1.0
uses: github.com/mozership/probe-slack@d11a6b6e6908b03c267a888a1e1b6cd187257c65 # v0.1.0The first release of probe-slack, a Probe action that posts a message to a Slack channel: the notes of a run, a text the workflow writes, or both.
Highlights
- A step gives the action the
notescontext of Probe, atext, or both, and it posts one message, by an Incoming Webhook (webhook_url) or with a bot token to the channel the step names (tokenandchannel). - The notes show as Block Kit
markdownblocks, each with an emoji of its level, its title, its body, and its job, step and status. The plain text of the message holds the same, for notifications and screen readers. - With no notes and no text nothing is posted, so a run on a schedule that leaves none sends no message.
- The URL of a webhook is its secret, so it is told neither in the result, nor in an error, nor in the log of the action.
Posting the notes of a run
A last job, which needs the others with always, reads the notes of them all:
- name: Tell the team
needs: [checkout]
always: true
steps:
- name: Post the critical notes
uses: slack
with:
webhook_url: "{{vars.slack_webhook}}"
text: Critical notes of the nightly run
notes: "{{ filter(notes, .level == 'critical') }}"The message it posts:
Critical notes of the nightly run
**The run left 1 note: 1 critical.**
🚨 **critical · The checkout button is under the cookie banner**
On a 390px wide screen the banner covers the button until it is closed.
_Checkout › A first-time shopper · passed_Each run posts a new message; a message kept up to date for each push belongs on the pull request, with probe-github-notes. A value Probe hides, <secret:NAME> or <redacted>, is put in code, as Slack would take it for a link or a mention. A message longer than Slack takes, 50 blocks and 12000 characters of markdown, leaves out its last notes and says how many. An error of Slack, such as channel_not_found, fails the step with what Slack answered.
Under --read-only a post is refused, and under --allow-host the host of the webhook or the API is checked.
Requirements
The action needs Probe v1.32.0 or later, the first with the notes context. See the README.
Changelog
- fdd73b7 Cut the plain text after escaping it, and not inside an entity
- c5b4a47 Escape masks by paragraph, and tell only the errors of Slack from a webhook
- 50a1ff5 Keep a mask apart from a code span next to it, and expect the longer span
- fe84045 Keep the webhook and the token out of the log, and masks in their spans
- 162a93f Merge pull request #1 from mozership/feat/action
- 75028db Post a message to a Slack channel, of the notes of a run or a text
- 50d21ec Start probe-slack with its license
- d0ee34d Tell the notes in the plain text too, and no more than the host in an error