chore(ci): add comment to direct new plugin contributors to contributing guide (#2598)

Signed-off-by: Hope Hadfield <hhadfiel@redhat.com>

Author: hopehadfield

.github/workflows/new-workspace-pr-comment.yml

@@ -0,0 +1,88 @@
+name: Comment on PRs that add a workspace
+
+on:
+  pull_request:
+    types: [opened, reopened, synchronize]
+    branches: [main]
+
+permissions:
+  contents: read
+  issues: write
+  pull-requests: write
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number }}
+  cancel-in-progress: true
+
+jobs:
+  comment-new-workspace:
+    name: Notify new workspace directory
+    if: github.repository == 'redhat-developer/rhdh-plugins' && github.event.pull_request.user.login != 'rhdh-bot'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Harden Runner
+        uses: step-security/harden-runner@5ef0c079ce82195b2a36a210272d6b661572d83e # v2.14.2
+        with:
+          egress-policy: audit
+
+      - name: Checkout PR head
+        uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4.3.1
+        with:
+          ref: ${{ github.event.pull_request.head.sha }}
+          fetch-depth: 0
+
+      - name: Fetch base commit
+        run: git fetch --no-tags origin ${{ github.event.pull_request.base.sha }}
+
+      - name: Detect new top-level directories under workspaces/
+        id: detect
+        env:
+          BASE_SHA: ${{ github.event.pull_request.base.sha }}
+          HEAD_SHA: ${{ github.event.pull_request.head.sha }}
+        run: |
+          set -euo pipefail
+          if git cat-file -e "${BASE_SHA}:workspaces" 2>/dev/null; then
+            git ls-tree "${BASE_SHA}:workspaces" | awk '$2=="tree" {print $4}' | sort -u > /tmp/base_ws.txt
+          else
+            : > /tmp/base_ws.txt
+          fi
+          if git cat-file -e "${HEAD_SHA}:workspaces" 2>/dev/null; then
+            git ls-tree "${HEAD_SHA}:workspaces" | awk '$2=="tree" {print $4}' | sort -u > /tmp/head_ws.txt
+          else
+            : > /tmp/head_ws.txt
+          fi
+          comm -13 /tmp/base_ws.txt /tmp/head_ws.txt > /tmp/new_ws.txt || true
+          if [ ! -s /tmp/new_ws.txt ]; then
+            echo "has_new=false" >> "$GITHUB_OUTPUT"
+          else
+            echo "has_new=true" >> "$GITHUB_OUTPUT"
+          fi
+
+      - name: Post PR comment
+        if: steps.detect.outputs.has_new == 'true'
+        uses: actions/github-script@f28e40c7f34bde8b3046d885e986cb6290c5673b # v7
+        with:
+          script: |
+            const marker = '<!-- rhdh-new-workspace-pr-comment -->';
+            const issue_number = context.payload.pull_request.number;
+            const comments = await github.paginate(github.rest.issues.listComments, {
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              issue_number,
+              per_page: 100,
+            });
+            if (comments.some((c) => c.body?.includes(marker))) {
+              return;
+            }
+            const contributing = `https://github.com/${context.repo.owner}/${context.repo.repo}/blob/main/CONTRIBUTING.md#submitting-a-pull-request-for-a-new-workspace`;
+            const body = [
+              marker,
+              '',
+              'This pull request adds a new top-level directory under `workspaces/`. Please follow **[Submitting a Pull Request for a New Workspace](' + contributing + ')** in `CONTRIBUTING.md`.',
+            ].join('\n');
+            await github.rest.issues.createComment({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              issue_number,
+              body,
+            });

CONTRIBUTING.md

@@ -22,7 +22,7 @@ The `redhat-developer/rhdh-plugins` repository is designed as a collaborative sp
     - [Next steps](#next-steps)
     - [Maintenance of older versions](#maintenance-of-older-versions)
   - [API Reports](#api-reports)
-  - [Submitting a Pull Request](#submitting-a-pull-request)
+  - [Submitting a Pull Request](#submitting-a-pull-request-for-a-new-workspace)
   - [Plugin Owner Responsibilities](#plugin-owner-responsibilities)
     - [Responsibilities](#responsibilities)
     - [Keeping Workspaces Up to Date with Backstage](#keeping-workspaces-up-to-date-with-backstage)
@@ -201,7 +201,6 @@ cp -r ../existing-plugins/plugins/plugin-name plugins/
 1. Prepare your environment by cloning a fork of both the `janus-idp/backstage-plugins` and the `backstage/rhdh-plugins` repositories
 
 2. In both repositories, create a new branch:
-
    - For `janus-idp/backstage-plugins`:
 
      ```bash
@@ -215,7 +214,6 @@ cp -r ../existing-plugins/plugins/plugin-name plugins/
      ```
 
 3. In the `backstage/rhdh-plugins` repository, execute the janus-plugin migrate command.- Usage:`yarn rhdh-cli janus-plugin migrate --monorepo-path [path_to_backstage_plugins]--workspace-name [workspace_name] --branch [branch_name] --maintainers [maintainer1],[maintainer2],[maintainer3],...`
-
    - The `path_to_backstage_plugins` is the path to the `backstage-plugins` project where the plugin(s) you want to migrate live.
    - The `workspace-name` is the name of the workspace you wish to create in the `rhdh-plugins` project. All plugins in the `backstage-plugins` that either are exactly or start with `@janus-idp/backstage-plugin-[workspace_name]` will be migrated to this new workspace.
    - The `branch_name` is the name of the branch in the `backstage-plugins` project where the changes to add a deprecate note for the migrated plugins will be made.
@@ -265,35 +263,35 @@ There are two ways you can do this:
 
 Each plugin/package has its own API Report which means you might see more than one file updated or created depending on your changes. These changes will then need to be committed as well.
 
-## Submitting a Pull Request
+## Submitting a Pull Request for a New Workspace
 
 When you've got your contribution working, tested, and committed to your branch it's time to create a Pull Request (PR). If you are unsure how to do this GitHub's [Creating a pull request from a fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) documentation will help you with that.
 
 For new plugins, it is recommended that your initial PR simply creates the workspace for your plugins. In this PR, be sure to add maintainers to the `CODEOWNERS` file for the new workspace. This will streamline the approval process, and also ensure that you have full autonomy over further development of your plugin.
 
-Please ping @rhdh-cope in #rhdh-plugins-ecosystem on Slack when the PR is ready for review. We will do our best to complete an initial review within 5 working days, and address any subsequent updates within 2 working days.
+Please ping @rhdh-cope in #rhdh-plugins-ecosystem on Slack when the PR is ready for review. We will do our best to complete an initial review within 5 working days, and address any subsequent updates within 2 working days. We will not begin this process until the CI is passing or CI failures are explicitly justified.
 
 ### Checklist to Ensure your Plugin is Ready to Merge
 
-* Workspace `package.json`
-  * `private: true`
-  * Use the correct repository url
-  * Keep workspace-level dependencies minimal
-* Plugin `package.json`
-  * For publishable plugins:
-    * Omit `private: true`
-    * Set `publishConfig.access` to `"public"`
-  * Include a valid `backstage` config with `role`, `pluginId`, and `pluginPackages`
-  * Use the correct repository URL
-* Required files
-  * Changeset is present
-  * README files with relevant documentation
-  * `backstage.json` specifying a compatible Backstage version
-* Configuration (if applicable)
-  * Include `config.d.ts` at the package level
-  * Add proper visibility annotations
-* Ownership
-  * Update `.github/CODEOWNERS` with appropriate maintainers
+- Workspace `package.json`
+  - `private: true`
+  - Use the correct repository url
+  - Keep workspace-level dependencies minimal
+- Plugin `package.json`
+  - For publishable plugins:
+    - Omit `private: true`
+    - Set `publishConfig.access` to `"public"`
+  - Include a valid `backstage` config with `role`, `pluginId`, and `pluginPackages`
+  - Use the correct repository URL
+- Required files
+  - Changeset is present
+  - README files with relevant documentation
+  - `backstage.json` specifying a compatible Backstage version
+- Configuration (if applicable)
+  - Include `config.d.ts` at the package level
+  - Add proper visibility annotations
+- Ownership
+  - Update `.github/CODEOWNERS` with appropriate maintainers
 
 ## Plugin Owner Responsibilities