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

Add a CHANGELOG.md #364

Open
shawnzhu opened this issue Aug 16, 2023 · 1 comment
Open

Add a CHANGELOG.md #364

shawnzhu opened this issue Aug 16, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@shawnzhu
Copy link
Member

From @epeters3

Idea: Include a Changelog page or a "What's New in Chroma" section on the home page of the Chroma site that allows consumers to see what's new.

I've seen some OSS repos automated changelog.md updates as part of release process via github actions. comments are welcome

@shawnzhu shawnzhu added the documentation Improvements or additions to documentation label Aug 16, 2023
@epeters3
Copy link

epeters3 commented Aug 16, 2023

I've seen some OSS repos automated changelog.md updates as part of release process via github actions. comments are welcome

I like this idea since it largely automates the process. We could add a semantic release workflow along with the GitHub action to automatically update CHANGELOG.md. Also there are Storybook integrations for rendering markdown files and changelog files.

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

No branches or pull requests

2 participants