feat(docs): automate compatibility and workspace table updates by Ayushmore1214 · Pull Request #7605 · backstage/community-plugins

Ayushmore1214 · 2026-02-14T14:07:34Z

Hey, I just made a Pull Request!

This PR automates the updating of workspace and compatibility tables, addressing #7583.

Previously, these tables had to be generated manually via local scripts, leading to stale documentation. This introduces a GitHub workflow that can be triggered on-demand to run the scripts, inject the fresh tables directly into the markdown files, and open a PR with the changes.

✔️ Checklist

A changeset describing the change and affected packages. (more info)
Added or updated documentation
Tests for new functionality and regression tests for bug fixes
Screenshots attached (for UI changes)
All your commits have a Signed-off-by line in the message. (more info)

Signed-off-by: Ayushmore1214 <ayushmore42595@gmail.com>

awanlin

Thanks for getting this started @Ayushmore1214, left a few comments for you to help get it moving forward. I'd rebase first as you have some conflicts, please don't close this PR, it's a great chance to learn and improve your git skills if you hit issues.

As for the CI error, that's an odd one, let see if after the rebase it just fixes itself. 👍

awanlin · 2026-02-15T13:35:17Z

  }

-  const table = args.includes('--table');
+  const table = arrayToTable(backendFeatureReports);


For this I would expect the flags to keep working the way they do but you would simply add a --save flag and then follow the same logic as what is done here:

community-plugins/scripts/list-feature.js

Lines 137 to 153 in b05e847

if (save) {

if (!config.reportPath) {

console.error(`--save is not supported for this role (${role})`);

process.exit(4);

}

await fs.writeFile(

config.reportPath,

(

await fs.readFile(config.reportPath, 'utf8')

).replace(

/[\s\S]*/,

`

${arrayToTable(reports)}

`,

awanlin · 2026-02-15T13:36:20Z

 > [!NOTE]
 > The "supported" column means the plugin has support for the New Frontend System, if the "alpha" column is "true" that means that the support is exported under the `/alpha` path.

-<!-- This table is automatically generated by the list-feature script -->


I would expect these comments to stay in place as they are needed when the script tries to update this the next time around.

awanlin · 2026-02-15T13:36:29Z

-| @backstage-community/plugin-stack-overflow                    | frontend-plugin        | true      | 1.47.2                        | true  | [README](https://github.com/backstage/community-plugins/blob/master/workspaces/stack-overflow/plugins/stack-overflow/README.md)                             |
-| @backstage-community/plugin-stackstorm                        | frontend-plugin        |           | 1.47.2                        |       | [README](https://github.com/backstage/community-plugins/blob/master/workspaces/stackstorm/plugins/stackstorm/README.md)                                     |
-| @backstage-community/plugin-tech-insights                     | frontend-plugin        | true      | 1.47.2                        | true  | [README](https://github.com/backstage/community-plugins/blob/master/workspaces/tech-insights/plugins/tech-insights/README.md)                               |
-| @backstage-community/plugin-tech-insights-maturity            | frontend-plugin        |           | 1.47.2                        |       | [README](https://github.com/backstage/community-plugins/blob/master/workspaces/tech-insights/plugins/tech-insights-maturity/README.md)                      |


Same with this one.

awanlin · 2026-02-15T13:37:31Z

+| @backstage-community/plugin-vault                        | frontend-plugin | true      | 1.43.2                        | true  | [README](https://github.com/backstage/community-plugins/blob/master/workspaces/vault/plugins/vault/README.md)                                               |
+| @backstage-community/plugin-wheel-of-names               | frontend-plugin |           | 1.43.2                        |       | [README](https://github.com/backstage/community-plugins/blob/master/workspaces/wheel-of-names/plugins/wheel-of-names/README.md)                             |
+| @backstage-community/plugin-xcmetrics                    | frontend-plugin |           | 1.42.3                        |       | [README](https://github.com/backstage/community-plugins/blob/master/workspaces/xcmetrics/plugins/xcmetrics/README.md)                                       |
 ## Generating Table


It makes sense to me to just removed this entirely but add a section to the workflow docs describing the workflow and the process: https://github.com/backstage/community-plugins/blob/main/docs/workflows.md

awanlin · 2026-02-15T13:39:10Z

@@ -17,227 +17,212 @@ The Compatibility folder contains the following items:

 ## Workspaces and Their Plugins


I expect to see this table being wrapped in a comment like this:

 Table Contents 

awanlin · 2026-02-15T13:39:49Z

@@ -5,116 +5,111 @@
 The following table lists what version of Backstage each workspace is currently compatible with. The Backstage version listed for each workspace is determined by looking at the `backstage.json` file at the root of each workspace. The badges are using the [Shields.io Dynamic JSON Badge](https://shields.io/badges/dynamic-json-badge) feature and are kept up to date automatically (when the page loads it will do this check against the file as it is on the `main` branch).

 > [!NOTE]


We can remove this, I mention documenting the workflow in the docs in another similar comment

awanlin · 2026-02-15T13:40:15Z

-| [vault](https://github.com/backstage/community-plugins/tree/main/workspaces/vault)                                                               | ![Dynamic JSON Badge](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fraw.githubusercontent.com%2Fbackstage%2Fcommunity-plugins%2Fmain%2Fworkspaces%2Fvault%2Fbackstage.json&query=%24.version&label=Backstage%20Version)                                |
-| [wheel-of-names](https://github.com/backstage/community-plugins/tree/main/workspaces/wheel-of-names)                                             | ![Dynamic JSON Badge](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fraw.githubusercontent.com%2Fbackstage%2Fcommunity-plugins%2Fmain%2Fworkspaces%2Fwheel-of-names%2Fbackstage.json&query=%24.version&label=Backstage%20Version)                       |
-| [xcmetrics](https://github.com/backstage/community-plugins/tree/main/workspaces/xcmetrics)                                                       | ![Dynamic JSON Badge](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fraw.githubusercontent.com%2Fbackstage%2Fcommunity-plugins%2Fmain%2Fworkspaces%2Fxcmetrics%2Fbackstage.json&query=%24.version&label=Backstage%20Version)                            |
+> This table is automatically updated by the `update-docs-tables` workflow.


I expect to see this table being wrapped in a comment like this:

 Table Contents 

awanlin · 2026-02-15T13:41:28Z

+          node scripts/list-workspaces-for-docs.js
+
+          echo "🔄 Updating Compatibility Tables..."
+          node scripts/list-compatibility.js


There should be 3 scripts called here, you are missing running list-feature.js

awanlin · 2026-02-15T13:41:48Z

+            cc @backstage/community-plugins-maintainers
+          branch: "auto/docs-table-update"
+          base: main 
+          delete-branch: true


Can you add a new line to the bottom of this file

awanlin · 2026-02-15T13:43:05Z

+            - `docs/compatibility/compatibility.md`
+            - `docs/compatibility/new-frontend-system.md`
+
+            cc @backstage/community-plugins-maintainers


We don't need this as we get automatically assigned based on the CODEOWNERS file. Also, as we will trigger it manually the person who did will be expecting it to generate 👍

Signed-off-by: Ayush More <ayushmore42595@gmail.com>

Signed-off-by: Ayushmore1214 <ayushmore42595@gmail.com>

awanlin

Hi @Ayushmore1214, I gave this another review, I'm not sure that's what you wanted to not yet as some of the comments look unresolved. Sorry about that. Going forward please just ping me so I know if I should review or not 👍

awanlin · 2026-02-20T18:53:18Z

  }

-  const table = args.includes('--table');
+  // --- AWANLIN'S REQUESTED LOGIC ---


You can remove this, we don't need it in the final script.

awanlin · 2026-02-20T18:54:39Z

+      // Use the Regex replacement method requested in the PR
+      const newContent = fileContent.replace(
+        /[\s\S]*/,
+        `\n${tableContent}\n`


This is an improvement but does this actually work? You removed the comments form the docs itself so my gut say no. I'd really suggest taking a deep dive into how scripts/list-feature.j works as that's the ideal pattern the script should follow.

awanlin · 2026-02-20T18:54:48Z

  console.error(error.stack || error);
  process.exit(1);
-});
+});


Can you add a new line, please?

Ayushmore1214 · 2026-02-25T23:57:37Z

@awanlin sorry for late follow up on this been busy last 4-5 days will push the changes by end of this week!

Signed-off-by: Ayush More <ayushmore42595@gmail.com>

awanlin · 2026-03-21T14:47:32Z

Hi @Ayushmore1214, ready for review?

Ayushmore1214 · 2026-03-21T16:57:55Z

Yes it is!

github-actions · 2026-04-20T18:24:19Z

This PR has been automatically marked as stale because it has not had recent activity from the author. It will be closed if no further activity occurs. If the PR was closed and you want it re-opened, let us know and we'll re-open the PR so that you can continue the contribution!

Ayushmore1214 requested a review from a team as a code owner February 14, 2026 14:07

Ayushmore1214 requested review from awanlin and removed request for a team February 14, 2026 14:07

feat: automate docs table updates

d24a9f2

Signed-off-by: Ayushmore1214 <ayushmore42595@gmail.com>

Ayushmore1214 force-pushed the main branch from d48f2d4 to d24a9f2 Compare February 14, 2026 14:09

awanlin requested changes Feb 15, 2026

View reviewed changes

Ayushmore1214 added 2 commits February 16, 2026 06:01

Merge branch 'main' into main

b9b9ad7

Signed-off-by: Ayush More <ayushmore42595@gmail.com>

fix: address PR feedback, use regex replacement and --save flag

4aca8ef

Signed-off-by: Ayushmore1214 <ayushmore42595@gmail.com>

awanlin requested changes Feb 20, 2026

View reviewed changes

fix: address Awanlin's feedback

9a36d4a

Signed-off-by: Ayush More <ayushmore42595@gmail.com>

Ayushmore1214 force-pushed the main branch from 2f83898 to 9a36d4a Compare March 9, 2026 00:58

github-actions Bot added the stale label Apr 20, 2026

	if (save) {
	if (!config.reportPath) {
	console.error(`--save is not supported for this role (${role})`);
	process.exit(4);
	}

	await fs.writeFile(
	config.reportPath,
	(
	await fs.readFile(config.reportPath, 'utf8')
	).replace(
	/<!-- This table is automatically generated by the list-feature script -->[\s\S]*<!-- end of table -->/,
	`<!-- This table is automatically generated by the list-feature script -->

	${arrayToTable(reports)}

	<!-- end of table -->`,

		@@ -17,227 +17,212 @@ The Compatibility folder contains the following items:

		## Workspaces and Their Plugins

		@@ -5,116 +5,111 @@
		The following table lists what version of Backstage each workspace is currently compatible with. The Backstage version listed for each workspace is determined by looking at the `backstage.json` file at the root of each workspace. The badges are using the [Shields.io Dynamic JSON Badge](https://shields.io/badges/dynamic-json-badge) feature and are kept up to date automatically (when the page loads it will do this check against the file as it is on the `main` branch).

		> [!NOTE]

Conversation

Ayushmore1214 commented Feb 14, 2026

Hey, I just made a Pull Request!

✔️ Checklist

Uh oh!

awanlin left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

awanlin left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Ayushmore1214 commented Feb 25, 2026

Uh oh!

awanlin commented Mar 21, 2026

Uh oh!

Ayushmore1214 commented Mar 21, 2026

Uh oh!

github-actions Bot commented Apr 20, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants