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

docs: Actualize CHANGELOG #359

Merged
merged 2 commits into from
Apr 5, 2024
Merged

docs: Actualize CHANGELOG #359

merged 2 commits into from
Apr 5, 2024

Conversation

yermulnik
Copy link
Collaborator

@yermulnik yermulnik commented Apr 5, 2024

  • Add changelog entries for each tag starting from the one that already existed in CHANGELOG
  • Utilized chelnak/gh-changelog to automate process
    • Manually adjusted where gh-changelog didn't make its job good enough

- Add changelog entries for each tag starting from the one that already
  existed in CHANGELOG
- Utilized [chelnak/gh-changelog](https://github.com/chelnak/gh-changelog)
  to automate process
@yermulnik yermulnik self-assigned this Apr 5, 2024
@crablab
Copy link
Collaborator

crablab commented Apr 5, 2024

Could we document how we're using this extension, since we're going to need contributors to run it on every PR.

More generally we'll probably need some contribution guidelines.

@yermulnik
Copy link
Collaborator Author

Could we document how we're using this extension, since we're going to need contributors to run it on every PR.

I'm not sure yet how this tool would work to update CHANGELOG as I used it only to generate CHANGELOG and it was the first time I used it.
Seemingly what we need to use to update CHANEGLOG is gh changelog new --from-version ${lastVersion} but I still need to verify this.

More generally we'll probably need some contribution guidelines.

Definitely. At this moment I'd say we're through the alignment process to understand and establish contribution rules and conventions. And in the meanwhile I thought actualizing CHANGELOG would be good to do.

@yermulnik yermulnik added documentation Add or improve documentation - README/comments on code enhancement Refactor existing code for better performance and quality labels Apr 5, 2024
@yermulnik
Copy link
Collaborator Author

@crablab I'm merging this at this moment and will try and compile contribution notes when we have the process more or less established.

@yermulnik yermulnik merged commit 6b94f75 into master Apr 5, 2024
2 checks passed
@yermulnik yermulnik deleted the enhancement/Update_Changelog branch April 5, 2024 17:38
@MatrixCrawler MatrixCrawler added this to the Release 1.1.0 milestone Apr 5, 2024
@warrensbox
Copy link
Owner

@yermulnik can you please take a look at this as well?
https://goreleaser.com/customization/changelog/
Since we are already using goreleaser

@yermulnik
Copy link
Collaborator Author

@yermulnik can you please take a look at this as well?
goreleaser.com/customization/changelog
Since we are already using goreleaser

Thanks for the pointer. Will look into it after weekend.

@MatrixCrawler MatrixCrawler added this to the Release 1.1.0 milestone Apr 16, 2024
@yermulnik
Copy link
Collaborator Author

yermulnik commented Apr 21, 2024

@yermulnik can you please take a look at this as well?
goreleaser.com/customization/changelog
Since we are already using goreleaser

Thanks for the pointer. Will look into it after weekend.

So I only now had a time to look into this and.. and, only after I had changed .goreleaser.yaml, I found that this actually is for release changelog, rather than for CHANGELOG.md 🤷🏻
https://goreleaser.com/quick-start/
изображение
Though I decided to create a PR out of this (just in case we may want it): #381

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Add or improve documentation - README/comments on code enhancement Refactor existing code for better performance and quality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants