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

Craft a solution for a 'centralized' changelog for the fuels package #970

Closed
Dhaiwat10 opened this issue May 3, 2023 · 4 comments
Closed
Labels
chore Issue is a chore

Comments

@Dhaiwat10
Copy link
Member

Currently, the CHANGELOG.md at the root of our project is a symlink that points to the CHANGELOG.md file inside of the fuels package. Apart from the fact that GitHub does not handle symlinks properly, and instead shows this:
image
... the CHANGELOG.md file inside the fuels package also does not contain all the changes that are incorporated in our codebases. It only includes information about version bumps to other packages.

Ideally, we should have a CHANGELOG.md file at the root of the repo where we append any and all the changes we add to any of the child packages' changelogs.

The motivation behind this is to make it easy for SDK users to browse through our version history and see what changes happened when.

@camsjams
Copy link
Contributor

camsjams commented May 3, 2023

The changelog should just reference the GitHub releases page, which has the best source of truth and is automated:
https://github.com/FuelLabs/fuels-ts/releases

@arboleya
Copy link
Member

arboleya commented May 4, 2023

I agree, but I also like the idea of a consolidated Changelog.

Perhaps a combination of all could involve:

  1. Improve the Changelog template (patch changes seems useless)
  2. Add a link to the Releases page at the very top of it
  3. Have a consolidated <repoRoot>/CHANGELOG.md with the all releases combined (probably auto-generated)

@arboleya
Copy link
Member

@arboleya arboleya added this to the 1.0 caterpillar milestone Jun 14, 2024
@arboleya
Copy link
Member

This should be automatically resolved by:

@arboleya arboleya added the p2 label Jun 14, 2024
@arboleya arboleya removed this from the 1.0 caterpillar milestone Jul 19, 2024
@arboleya arboleya closed this as not planned Won't fix, can't repro, duplicate, stale Jul 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Issue is a chore
Projects
None yet
Development

No branches or pull requests

4 participants