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

Where to find a changelog? #750

Open
meznaric opened this issue Jul 8, 2020 · 3 comments
Open

Where to find a changelog? #750

meznaric opened this issue Jul 8, 2020 · 3 comments

Comments

@meznaric
Copy link
Contributor

meznaric commented Jul 8, 2020

I haven't upgraded haul on my project for quite some time, now all my @haul-bundler/* packages are all outdated. How should I approach upgrading?

I noticed one of the patches was merged that I need but I have no idea if it was released.

It's not the first time I encountered this. Simply having changelog would make this much easier.

@meznaric meznaric added the question Further information is requested label Jul 8, 2020
@zamotany
Copy link
Contributor

zamotany commented Jul 8, 2020

I agree, there's much to be done in terms of maintenance, changelog etc. For now, the best source of truth is to look a commit history: https://github.com/callstack/haul/commits/master
There are chore: publish commits which contain published packages and their versions, so when you find a patch/commit you're interested, check if it has chore: publish commit above it.

@zamotany zamotany added docs enhancement good first issue and removed question Further information is requested labels Jul 8, 2020
@meznaric
Copy link
Contributor Author

meznaric commented Jul 8, 2020

Thanks for swift response! I see how it works now, basically versions don't necessarily need to match, they are released/upgraded as needed. Commits in between will tell me what the change was.

I see you put a "good first issue" tag to it, what do you imagine as part of this?
I can see 2 things being done:

  • Just documentation improved that explain what you explained to me in more detail
  • Automated changelog generation. If I was to build shell/node script that would generate/update CHANGELOG.md based on the commits, would you integrate it with CI? - I haven no experience with circle.

@zamotany
Copy link
Contributor

zamotany commented Jul 8, 2020

The process of generating changelog can be automated by Learn, which we use for managing monorepo, so it boils down to add proper options to lerna commands to generate it since the commit messages follow Conventional Commits: https://github.com/lerna/lerna/tree/master/commands/version#--conventional-commits
The cherry on top would be also a automatic Github Releases creation, but that's more complex so can be left for later.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants