[infra] Create reusable workflows (#178)

Signed-off-by: Michel Engelen <32863416+michelengelen@users.noreply.github.com>
Co-authored-by: MUI bot <2109932+Janpot@users.noreply.github.com>
Co-authored-by: Jose C Quintas Jr <juniorquintas@gmail.com>
Co-authored-by: Olivier Tassinari <olivier.tassinari@gmail.com>

Author: 4 people

.github/workflows/reusable/add-closing-message-to-issue.yml

@@ -0,0 +1,29 @@
+name: Add closing message to issue
+
+on:
+  issues:
+    types:
+      - closed
+  workflow_call:
+
+permissions: {}
+
+jobs:
+  add-comment:
+    runs-on: ubuntu-latest
+    name: Check author permission and add closing message
+    permissions:
+      issues: write
+    steps:
+      - name: Check out public repo
+        uses: actions/checkout@v3
+        with:
+          # Check this repository out, otherwise the script won't be available,
+          # as it checks out the repository where the workflow caller is located
+          repository: mui/mui-public
+      - name: Add closing message
+        uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
+        with:
+          script: |
+            const script = require('./.github/workflows/scripts/addClosingMessage.js')
+            await script({core, github, context})

.github/workflows/scripts/addClosingMessage.js

@@ -0,0 +1,75 @@
+// @ts-check
+
+/**
+ * @param {Object} params
+ * @param {import("@actions/core")} params.core
+ * @param {ReturnType<import("@actions/github").getOctokit>} params.github
+ * @param {import("@actions/github").context} params.context
+ */
+module.exports = async ({ core, context, github }) => {
+  try {
+    const owner = context.repo.owner;
+    const repo = context.repo.repo;
+    const issueNumber = context.issue.number;
+
+    const issue = await github.rest.issues.get({
+      owner,
+      repo,
+      issue_number: issueNumber,
+    });
+
+    const repositoryMap = {
+      'mui-x': 'x',
+      'material-ui': 'core',
+      'base-ui': 'base',
+      'pigment-css': 'pigment',
+      'mui-toolpad': 'toolpad',
+    };
+
+    const commentLines = [
+      `**This issue has been closed.** If you have a similar problem but not exactly the same, please open a [new issue](https://github.com/mui/${repo}/issues/new/choose).`,
+      'Now, if you have additional information related to this issue or things that could help future readers, feel free to leave a comment.',
+    ];
+
+    const userPermission = await github.rest.repos.getCollaboratorPermissionLevel({
+      owner,
+      repo,
+      username: issue.data.user.login,
+    });
+
+    core.debug(`>>> Author permission level: ${userPermission.data.permission}`);
+
+    // Only ask for feedback if the user is not an admin or has at least write access (from a team membership)
+    if (!['admin', 'write'].includes(userPermission.data.permission)) {
+      commentLines.push('> [!NOTE]');
+      commentLines.push(
+        `> We value your feedback @${issue.data.user.login}! How was your experience with our support team?`,
+      );
+      commentLines.push(
+        `> If you could spare a moment, we'd love to hear your thoughts in this brief [Support Satisfaction survey](https://tally.so/r/w4r5Mk?issue=${issueNumber}&productId=${repositoryMap[repo]}). Your insights help us improve!`,
+      );
+    }
+
+    const body = commentLines.join('\n');
+    core.debug(`>>> Prepared comment body: ${body}`);
+
+    await github.rest.issues.createComment({
+      owner,
+      repo,
+      issue_number: issueNumber,
+      body,
+    });
+
+    const labelName = 'status: waiting for maintainer';
+    core.debug(`>>> Removing label: ${labelName}`);
+
+    await github.rest.issues.removeLabel({
+      owner,
+      repo,
+      issue_number: issueNumber,
+      name: labelName,
+    });
+  } catch (error) {
+    core.setFailed(error.message);
+  }
+};

package.json

@@ -9,6 +9,8 @@
     "prettier:all": "prettier --write . --ignore-path .eslintignore"
   },
   "devDependencies": {
+    "@actions/core": "^1.10.1",
+    "@actions/github": "^6.0.0",
     "@mui/monorepo": "https://github.com/mui/material-ui.git#master",
     "@typescript-eslint/eslint-plugin": "7.12.0",
     "@typescript-eslint/parser": "7.12.0",