From 75502c2e14082a58848617661b4c8e7acb239acd Mon Sep 17 00:00:00 2001 From: Michel Engelen <32863416+michelengelen@users.noreply.github.com> Date: Fri, 19 Apr 2024 12:23:27 +0200 Subject: [PATCH] [support-infra] Add release announcement to GitHub workflows (#11867) (#12843) Signed-off-by: Michel Engelen <32863416+michelengelen@users.noreply.github.com> Co-authored-by: Olivier Tassinari --- .../discord-release-announcement.yaml | 20 +++++++++++++++++++ scripts/README.md | 6 +++++- scripts/releaseChangelog.mjs | 2 ++ 3 files changed, 27 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/discord-release-announcement.yaml diff --git a/.github/workflows/discord-release-announcement.yaml b/.github/workflows/discord-release-announcement.yaml new file mode 100644 index 0000000000000..11360a820d9d1 --- /dev/null +++ b/.github/workflows/discord-release-announcement.yaml @@ -0,0 +1,20 @@ +name: Discord Release Announcement + +on: + release: + types: [prereleased, published] + +permissions: {} + +jobs: + delimiter-test: + runs-on: ubuntu-latest + name: Send message to discord + steps: + - name: parse and send message + uses: michelengelen/discord-message-action@02af30a15955ecf718049bc33b0efabf6f626e0b + with: + webhook-url: ${{ secrets.DISCORD_WEBHOOK_URL }} + username: MUI Releases + avatar-url: 'https://raw.githubusercontent.com/mui/material-ui/master/docs/public/static/logo.png' + separator: '' diff --git a/scripts/README.md b/scripts/README.md index 416adebde670a..f26e7925ba80c 100644 --- a/scripts/README.md +++ b/scripts/README.md @@ -23,7 +23,11 @@ yarn release:changelog --release The branch to release (default: master) ``` -You can also provide the GitHub token by setting `process.env.GITHUB_TOKEN` variable. +> :warning: the script will add a separator string in form of a comment like this right after the highlights: +> `` +> This string needs to stay where it gets inserted for the automated discord announcement to work. + +You can also provide the github token by setting `process.env.GITHUB_TOKEN` variable. In case of a problem, another method to generate the changelog is available at the end of this page. diff --git a/scripts/releaseChangelog.mjs b/scripts/releaseChangelog.mjs index 2f528a340a7d2..25d39443f38bd 100644 --- a/scripts/releaseChangelog.mjs +++ b/scripts/releaseChangelog.mjs @@ -267,6 +267,8 @@ We'd like to offer a big thanks to the ${ TODO INSERT HIGHLIGHTS ${changeLogMessages.length > 0 ? '\n\n' : ''}${changeLogMessages.join('\n')} + + ### Data Grid #### \`@mui/x-data-grid@__VERSION__\`