-
Notifications
You must be signed in to change notification settings - Fork 186
chore(docs): add script to generate versions.md in dynamic plugins doc #2808
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds a script to generate a versions.md file for the dynamic plugins documentation along with a GitHub workflow that automates the update process when key files are changed.
- Introduces a new Node.js script (update-versions-doc.mjs) to generate documentation.
- Adds a GitHub Actions workflow (update-versions.yaml) to trigger the version update PR.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
File | Description |
---|---|
scripts/update-versions-doc.mjs | New script that collects branch and package version info to generate versions.md |
.github/workflows/update-versions.yaml | Workflow configuration to run the script and create a PR when key files are updated |
Comments suppressed due to low confidence (1)
scripts/update-versions-doc.mjs:202
- The use of 'console.fail' is not a standard method in Node.js. Consider using 'console.error' followed by terminating the process (e.g., process.exit(1)) to handle the error.
console.fail(`Unable to find create-app version in ${createAppVersion}`)
The image is available at: |
This PR is stale because it has been open 7 days with no activity. Remove stale label or comment or this will be closed in 21 days. |
The image is available at: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
The image is available at: |
Two thoughts (but otherwise +1):
Also copilot complained:
|
good point, will do that. Not sure why I did not do that at from start.
I think that it still makes sense to keep the old branches, there is really no harm in it, they might be useful for some historical references
this has bee already fixed a while back |
e78be22
to
637163b
Compare
The image is available at: |
also adds github workflow to run this every time the the packages.json is updated. Workflow opens PR with the versions.md updated content Signed-off-by: Tomas Kral <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Paul Schultz <[email protected]>
637163b
to
fe6f513
Compare
fe6f513
to
f079097
Compare
The image is available at: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM - nice to see the old 1.0-1.2 stuff has been purged.
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: gashcrumb, nickboldt The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Description
backstage.json
,packages/app/package.json
orpackages/backend/package.json
is updated. Workflow opens PR with updated versions.md fileWhich issue(s) does this PR fix
PR acceptance criteria
Please make sure that the following steps are complete:
How to test changes / Special notes to the reviewer