From 6de4c20b9a838e65b62a1e55fc8a1eb571408e7a Mon Sep 17 00:00:00 2001 From: michel Date: Tue, 30 Jan 2024 17:23:54 +0100 Subject: [PATCH 01/10] adds release announcement to github workflows --- .../workflows/discord-release-announcement.yaml | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) 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 000000000000..25f096f1cbd8 --- /dev/null +++ b/.github/workflows/discord-release-announcement.yaml @@ -0,0 +1,17 @@ +name: Discord Release Announcement + +on: + release: + types: [ prereleased, published ] + +jobs: + delimiter-test: + runs-on: ubuntu-latest + name: Send message to discord + steps: + - name: parse and send message + uses: michelengelen/discord-message-action@c02d0aeda64482b2edecbbc965258d31c531a1c5 + with: + webhook-url: ${{ secrets.DISCORD_WEBHOOK_URL }} + username: MUI Releases + separator: '' From 36060902636ffb3f798977e05b5991542d84ea1f Mon Sep 17 00:00:00 2001 From: michel Date: Tue, 30 Jan 2024 17:30:44 +0100 Subject: [PATCH 02/10] added a section into the README for the release and added the separator string into the changelog script --- .github/workflows/discord-release-announcement.yaml | 2 +- scripts/README.md | 4 ++++ scripts/releaseChangelog.mjs | 2 ++ 3 files changed, 7 insertions(+), 1 deletion(-) diff --git a/.github/workflows/discord-release-announcement.yaml b/.github/workflows/discord-release-announcement.yaml index 25f096f1cbd8..fb995e50ed83 100644 --- a/.github/workflows/discord-release-announcement.yaml +++ b/.github/workflows/discord-release-announcement.yaml @@ -14,4 +14,4 @@ jobs: with: webhook-url: ${{ secrets.DISCORD_WEBHOOK_URL }} username: MUI Releases - separator: '' + separator: '' diff --git a/scripts/README.md b/scripts/README.md index 3c48aee3391f..12b46ecc6602 100644 --- a/scripts/README.md +++ b/scripts/README.md @@ -23,6 +23,10 @@ yarn release:changelog --release The branch to release (default: master) ``` +> :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 f616cf4b5e5f..23c5aff9091d 100644 --- a/scripts/releaseChangelog.mjs +++ b/scripts/releaseChangelog.mjs @@ -227,6 +227,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__\` From ea023752acb66cd7e00239d25d2809737997559a Mon Sep 17 00:00:00 2001 From: michel Date: Tue, 30 Jan 2024 17:38:50 +0100 Subject: [PATCH 03/10] changed commit SHA on action --- .github/workflows/discord-release-announcement.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/discord-release-announcement.yaml b/.github/workflows/discord-release-announcement.yaml index fb995e50ed83..ae7b2f732c47 100644 --- a/.github/workflows/discord-release-announcement.yaml +++ b/.github/workflows/discord-release-announcement.yaml @@ -10,7 +10,7 @@ jobs: name: Send message to discord steps: - name: parse and send message - uses: michelengelen/discord-message-action@c02d0aeda64482b2edecbbc965258d31c531a1c5 + uses: michelengelen/discord-message-action@e5f378aae752589a3d6bc7f595a47e273e398aaa with: webhook-url: ${{ secrets.DISCORD_WEBHOOK_URL }} username: MUI Releases From ecbf889c38b88e3a896a2f9a11ca49e9cdca2a2b Mon Sep 17 00:00:00 2001 From: michel Date: Wed, 31 Jan 2024 12:28:20 +0100 Subject: [PATCH 04/10] make linter happy --- .github/workflows/discord-release-announcement.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/discord-release-announcement.yaml b/.github/workflows/discord-release-announcement.yaml index ae7b2f732c47..5ee99fdbacfa 100644 --- a/.github/workflows/discord-release-announcement.yaml +++ b/.github/workflows/discord-release-announcement.yaml @@ -2,7 +2,7 @@ name: Discord Release Announcement on: release: - types: [ prereleased, published ] + types: [prereleased, published] jobs: delimiter-test: From 7b7e80940cf21a45908a54ea32d6823945a6d276 Mon Sep 17 00:00:00 2001 From: michel Date: Wed, 31 Jan 2024 15:00:35 +0100 Subject: [PATCH 05/10] changed version SHA on action --- .github/workflows/discord-release-announcement.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/discord-release-announcement.yaml b/.github/workflows/discord-release-announcement.yaml index 5ee99fdbacfa..aece4d31ab89 100644 --- a/.github/workflows/discord-release-announcement.yaml +++ b/.github/workflows/discord-release-announcement.yaml @@ -10,7 +10,7 @@ jobs: name: Send message to discord steps: - name: parse and send message - uses: michelengelen/discord-message-action@e5f378aae752589a3d6bc7f595a47e273e398aaa + uses: michelengelen/discord-message-action@02af30a15955ecf718049bc33b0efabf6f626e0b with: webhook-url: ${{ secrets.DISCORD_WEBHOOK_URL }} username: MUI Releases From ed568e6bb8a3cd9d391523a043307493386b8313 Mon Sep 17 00:00:00 2001 From: michel Date: Wed, 31 Jan 2024 15:01:28 +0100 Subject: [PATCH 06/10] added avatar-url to action inputs --- .github/workflows/discord-release-announcement.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/discord-release-announcement.yaml b/.github/workflows/discord-release-announcement.yaml index aece4d31ab89..e1f79662b772 100644 --- a/.github/workflows/discord-release-announcement.yaml +++ b/.github/workflows/discord-release-announcement.yaml @@ -14,4 +14,5 @@ jobs: with: webhook-url: ${{ secrets.DISCORD_WEBHOOK_URL }} username: MUI Releases + avatar-url: 'https://i.ibb.co/YfMzb7r/logo.png' separator: '' From 9a72724fb3cb5fdc44c367fdfbc037fc61bb7fe0 Mon Sep 17 00:00:00 2001 From: michel Date: Wed, 7 Feb 2024 12:21:36 +0100 Subject: [PATCH 07/10] added permission reset --- .github/workflows/discord-release-announcement.yaml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/discord-release-announcement.yaml b/.github/workflows/discord-release-announcement.yaml index e1f79662b772..b45d32b9ddd7 100644 --- a/.github/workflows/discord-release-announcement.yaml +++ b/.github/workflows/discord-release-announcement.yaml @@ -4,6 +4,8 @@ on: release: types: [prereleased, published] +permissions: {} + jobs: delimiter-test: runs-on: ubuntu-latest From a7af3f6d20c1893c742410da1e390c5599d1fdda Mon Sep 17 00:00:00 2001 From: michel Date: Thu, 8 Feb 2024 14:34:23 +0100 Subject: [PATCH 08/10] added link to logo in github repo --- .github/workflows/discord-release-announcement.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/discord-release-announcement.yaml b/.github/workflows/discord-release-announcement.yaml index b45d32b9ddd7..8c9007b7e8e3 100644 --- a/.github/workflows/discord-release-announcement.yaml +++ b/.github/workflows/discord-release-announcement.yaml @@ -16,5 +16,5 @@ jobs: with: webhook-url: ${{ secrets.DISCORD_WEBHOOK_URL }} username: MUI Releases - avatar-url: 'https://i.ibb.co/YfMzb7r/logo.png' + avatar-url: 'https://raw.githubusercontent.com/mui/material-ui/master/docs/public/static/logo.png' separator: '' From c843c7f5a000d116467ab78711e0d2be7a55528a Mon Sep 17 00:00:00 2001 From: Michel Engelen <32863416+michelengelen@users.noreply.github.com> Date: Fri, 23 Feb 2024 15:56:19 +0100 Subject: [PATCH 09/10] Update scripts/releaseChangelog.mjs Co-authored-by: Olivier Tassinari Signed-off-by: Michel Engelen <32863416+michelengelen@users.noreply.github.com> --- scripts/releaseChangelog.mjs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/releaseChangelog.mjs b/scripts/releaseChangelog.mjs index 23c5aff9091d..da0ea97f1825 100644 --- a/scripts/releaseChangelog.mjs +++ b/scripts/releaseChangelog.mjs @@ -227,7 +227,7 @@ We'd like to offer a big thanks to the ${ TODO INSERT HIGHLIGHTS ${changeLogMessages.length > 0 ? '\n\n' : ''}${changeLogMessages.join('\n')} - + ### Data Grid From ce223550641162905b93f1ed50a7d8c7e0710afa Mon Sep 17 00:00:00 2001 From: michel Date: Fri, 23 Feb 2024 15:58:41 +0100 Subject: [PATCH 10/10] changed separator string --- .github/workflows/discord-release-announcement.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/discord-release-announcement.yaml b/.github/workflows/discord-release-announcement.yaml index 8c9007b7e8e3..11360a820d9d 100644 --- a/.github/workflows/discord-release-announcement.yaml +++ b/.github/workflows/discord-release-announcement.yaml @@ -17,4 +17,4 @@ jobs: 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: '' + separator: ''