backstage icon indicating copy to clipboard operation
backstage copied to clipboard

feat: allow multiple CLI reports for easier diff

Open aramissennyeydd opened this issue 10 months ago • 3 comments

Hey, I just made a Pull Request!

As I'm working to migrate more commands to the module system, the current process is extremely manual in verifying 2 things,

  1. That the API surface remains the same (same options)
  2. That the functionality remains the same.

This PR adds a separate API report that can reasonably easily be diff'd against the main API report for validating the API surface and seeing if there were changes. It also sorts the CLI options to reduce noise where the order commands are registered in changes.

This may be something we only want to add once we're more confident in the module system + ready to start exposing it as a bin/public entrypoint.

:heavy_check_mark: Checklist

  • [x] 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)
  • [x] All your commits have a Signed-off-by line in the message. (more info)

aramissennyeydd avatar Mar 02 '25 15:03 aramissennyeydd

Missing Changesets

The following package(s) are changed by this PR but do not have a changeset:

  • @backstage/cli
  • @backstage/repo-tools

See CONTRIBUTING.md for more information about how to add changesets.

Changed Packages

Package Name Package Path Changeset Bump Current Version
@backstage/cli packages/cli none v0.32.0-next.1
@backstage/repo-tools packages/repo-tools none v0.13.1

backstage-goalie[bot] avatar Mar 02 '25 15:03 backstage-goalie[bot]

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!

github-actions[bot] avatar Mar 16 '25 15:03 github-actions[bot]

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!

github-actions[bot] avatar Mar 30 '25 21:03 github-actions[bot]

@Rugvip / @camilaibs Looks like I still need a review from @backstage/techdocs-maintainers, could you help out with that?

aramissennyeydd avatar Apr 07 '25 13:04 aramissennyeydd

@aramissennyeydd this needs api reports though, right?

freben avatar Apr 08 '25 08:04 freben