Skip to content
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

POC Changelog viewer #21

Open
wants to merge 111 commits into
base: master
Choose a base branch
from
Open

POC Changelog viewer #21

wants to merge 111 commits into from

Conversation

Sarabadu
Copy link

@Sarabadu Sarabadu commented Jan 8, 2025

Summary

The upgrade helper really makes the most common changes easier to be highlighted, but for the changes that are not in the create-app we have 2 cases:

  • If the package lives in backstage/backstage repo the cli will point out to the changelog file for that package :noice:
  • If the package lives somewhere else, the cli only warns you about posible changes.

In this POC we are adding a new route that gets the package name and version as part of the url and queries the changelog file for that package and version from npm (just CHANGELOG.md for now, maybe requires more posible names in the future.

NOTE: this POC was made on top of this big PR #20 , and It requires some work to make it mergable recommend to look on 5d7b427 commit for the POC part

How it looks

You can see it working here https://sarabadu.github.io/upgrade-helper/changelog/@backstage-community/plugin-announcements/0.1.2 , changing the packages and versions

image

Thoughts

  • The npm api used here in not documented, so it could get some silent braking changes
  • The changelog content is queried from the package version it self, so in contrast with showing the github file on main this will show only the relevant changes for the updated version and not include any next version changes

Test Plan

What are the steps to reproduce?

Checklist

  • I tested this thoroughly
  • I added the documentation in README.md (if needed)

Andrei Shikov and others added 30 commits January 5, 2025 01:05
previously on a comparison page like this one [1], we were having an
issue, where the changelog link was not set. this was due to the package
name not being accessible for the "UsefulLinks" component.
this commit fixes this issue

[1]: https://react-native-community.github.io/upgrade-helper/?from=0.63.4&to=0.69.0
Bumps [terser](https://github.com/terser/terser) from 4.4.3 to 4.8.1.
- [Release notes](https://github.com/terser/terser/releases)
- [Changelog](https://github.com/terser/terser/blob/master/CHANGELOG.md)
- [Commits](https://github.com/terser/terser/commits)

---
updated-dependencies:
- dependency-name: terser
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
markrickert and others added 28 commits January 5, 2025 02:03
Also updates the UsefulLinks class to a functional component
Fix the CompletedFilesCounter test
When running `yarn start`, the console would complain:

WARNING in ./node_modules/react-diff-view/es/index.js
Module Warning (from ./node_modules/source-map-loader/dist/cjs.js):
Failed to parse source map from ‘~/react-native-upgrade-helper/node_modules/react-diff-view/src/utils/parse.ts' file: Error: ENOENT: no such file or directory, open ‘~/react-native-upgrade-helper/node_modules/react-diff-view/src/utils/parse.ts'
Signed-off-by: Juan Pablo Garcia Ripa <[email protected]>
Signed-off-by: Juan Pablo Garcia Ripa <[email protected]>
Signed-off-by: Juan Pablo Garcia Ripa <[email protected]>
Signed-off-by: Juan Pablo Garcia Ripa <[email protected]>
Signed-off-by: Juan Pablo Garcia Ripa <[email protected]>
Signed-off-by: Juan Pablo Garcia Ripa <[email protected]>
Signed-off-by: Juan Pablo Garcia Ripa <[email protected]>
@Sarabadu Sarabadu requested review from vinzscam and a team as code owners January 8, 2025 08:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.