📝 Docs: Create CHANGELOG.md using changelog-from-release #38
Conversation
…d generate CHANGELOG.md file
|
Do you want to add it to the docs? |
|
Yes, good idea, I will update the index.md with the changelog. |
…gelog to the last part of the project support section
…, and update the docs README with this change
|
Somehow the bullet points are not separated: https://vuecore--38.org.readthedocs.build/en/38/sections_readme/changelog.html |
enryH
left a comment
enryH
left a comment
There was a problem hiding this comment.
I would remove these two points. I tried to see where this got picked up from, and it looks like the last line is used from the commit message:
Do you know more?
Co-authored-by: Henry Webel <heweb@dtu.dk>
Co-authored-by: Henry Webel <heweb@dtu.dk>
|
I am not sure why it just takes the last line from the commit, but I will take a look at the documentation to check if they explain it. |
…DME just in case users cannot run the makefile
|
It's a bit tricky how git-changelog identifies the commits from each release. I just kept the release number, date and the comparison to the previous one in |
|
I would be nice to have it maybe parsed from GitHub: https://github.com/Multiomics-Analytics-Group/vuecore/releases |
|
Maybe we could test another changelog creator: https://github.com/rhysd/changelog-from-release |
enryH
left a comment
enryH
left a comment
There was a problem hiding this comment.
Otherwise everything looks good!
…alse to prevent error
… the generated changelog
… update the github action to automate it after every release
… tool to create changelog
|
Hey @enryH! I updated the changelog using the changelog-from-release tool and added the workflow to the CI/CD GitHub action. |
|
just a few old unicode symbols are not recognized for whatever reason: https://vuecore--38.org.readthedocs.build/en/38/sections_readme/changelog.html 
and the url is printed next to the set link |
sayalaruano
changed the title
Summary
Create
CHANGELOG.mdusing the changelog-from-release tool, and add a GitHub action workflow to update it automatically after every new release.List of changes proposed in this PR (pull-request)
cdci.ymlGitHub action with a workflow to update the changelog automatically after every new release.CHANGELOG.mdFILE.