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.

Sign up for GitHub

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

Jump to bottom

chore: adding changelog generator #448

Closed
wants to merge 5 commits into from
Closed

chore: adding changelog generator #448

wants to merge 5 commits into from

Conversation

Saeid-Za
Copy link
Contributor

@Saeid-Za Saeid-Za commented Apr 1, 2024

Adding change log generation via changelogen.

I've changed the bumpp script in package.json to use the new generation script.
I've also added the CHANGELOG.md file, containing all of the previous releases.

The new bumpp command would do the following tasks:

  1. Bump the version (Automatic/Manual)
  2. Update CHANGELOG.md file
  3. Generate changelog for automatic release PR description.
  4. Push the new PR and setting it to draft status

from this point onward, a maintainer would check the PR, change the description if required, then merge it with dev branch.

To test this script:

  1. Create a Github token to access project via API
  2. Create/update .env file, following .env.example structure
  3. Create a fork of shadcn-vue and change content of changelog.config.ts to match the new created fork.
    3.1 This step is really important as we would be manipulating the original repo if the tester has write access to shadcn-vue
  4. Create a dummy commit following conventional commits instructions.
  5. Execute npm run bumpp
  6. Select the desired new version
  7. Done

Please feel free to share your thoughts and suggestions.
What is left is changelog page for app, which I'll be working on it soon.

@zernonia zernonia linked an issue Apr 2, 2024 that may be closed by this pull request
[Feature]: Add changelog page #437
Open
2 tasks
zernonia
zernonia reviewed Apr 2, 2024
View reviewed changes
scripts/changelog.ts

const remoteName = 'origin'

// Taken from Nuxt Repo (https://github.com/nuxt/nuxt/tree/main/scripts)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Appreciate the reference link here! 💚

@zernonia
Copy link
Contributor

zernonia commented Apr 2, 2024 •
edited

Thanks @Saeid-Za for the PR! May I ask what's the main difference between using this scripts/changelog and https://github.com/changesets/changesets ya? I'm kinda leaning towards changesets for the moment as we can utilize it for better version control, and don't need to worry about maintaining our own scripts.

WDYT @sadeghbarati ?

@sadeghbarati
Copy link
Collaborator

main difference between using this scripts/changelog and https://github.com/changesets/changesets ya?

changelogen's changelog is fancier than changesets changelog 😄 I wonder if we could exact same style from changelogen in changesets

@Saeid-Za
Copy link
Contributor Author

Saeid-Za commented Apr 2, 2024 •
edited

Thanks for the feedback !
Well, this is not solely about styling, let me elaborate.

I'm kinda leaning towards changesets for the moment as we can utilize it for better version control, and don't need to worry about maintaining our own scripts.

  1. I'm not sure if I understand the version control part, why would it be better? we still have the manual (if needed of course) control over what version we're releasing. the script is using bumpp under the hood and supports granular control.
  2. Not that maintaining the script is inherently a bad idea, but I understand that it would require further burden if change is frequent. I don't think this script needs changing that much, furthermore, We will always need a script if we would to automate PR request with changelog, see the nuxt release page.

If you think changeset is a better alternative, we could swap changelogen with that, because they are really the same tool (with almost the same API) for the same job, but if we were to add automated PRs for releasing the new version with changelog, some sort of script should exist

Is there anything I missed?

@Saeid-Za
Copy link
Contributor Author

Saeid-Za commented Apr 8, 2024

Oh, It seems that I was wrong on one point. This repo has a Bot that generates changelog for github. I'll close the PR since this doesn't bring any value.
We still miss a changelog.md file though.

@Saeid-Za Saeid-Za closed this Apr 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@zernonia zernonia zernonia left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Feature]: Add changelog page
3 participants
@Saeid-Za @zernonia @sadeghbarati