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

Modify merge-main github action to push updates to changelog.md #470

Open
2 tasks
Tracked by #467
aatmanvaidya opened this issue Jan 2, 2025 · 2 comments
Open
2 tasks
Tracked by #467

Comments

@aatmanvaidya
Copy link
Collaborator

aatmanvaidya commented Jan 2, 2025

Feluda has multiple python packages in a single github repo, we could not find any existing tool/GitHub actions that can help us release and do semantic versioning of multiple packages in a monorepo. Hence we had to write our own custom script that does this for us. This is the GitHub action that trigger’s the workflow for semantic versioning - link. Wherever a PR is merged to main branch, this GitHub action is triggered.

Currently, whenever a change is made to feluda pacakge, a github release is made. But the CHANGELOG.md does not get updated.

  • The task of the issue is to modify the GitHub action to always update CHANGELOG.md along with the GitHub release. I have written some starter code for this - link.
    • The main challenge here is that, when using a custom markdown file as release notes, GitHub does not automatically include the list of contributors and alters the formatting of changes in the release notes.
  • Additionally, right now when a GitHub release is made just for feluda, all commits are present in the notes, how do we make sure only the commits that made changes to feluda/ folder i.e. the feluda python packages are only present
@dennyabrain
Copy link
Contributor

I am guessing the link to the website https://changelog.md/ is unintentional?

@aatmanvaidya
Copy link
Collaborator Author

yes it was, fixed it

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