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

chore: towncrier workflow to trigger changelog build #223

Closed
wants to merge 9 commits into from

Conversation

ThibaultFy
Copy link
Member

@ThibaultFy ThibaultFy commented Jun 27, 2024

Summary

Part of converting auto release script into Python, we need a Github action to be triggered with python to create and edit the changelog.

This workflow is dispatch only, and commit the changes directly to the branch.

To be tested on SubstraFL and to propagate to all repo if the test is a success.

See https://github.com/Substra/substrafl/actions/runs/9698562413 for a successful run

Notes

Please check if the PR fulfills these requirements

  • If the feature has an impact on the user experience, the changelog has been updated
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • The commit message follows the conventional commit specification

ThibaultFy and others added 9 commits June 27, 2024 16:27
changelog build

Signed-off-by: ThibaultFy <[email protected]>
changelog build

Signed-off-by: ThibaultFy <[email protected]>
Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@ThibaultFy ThibaultFy marked this pull request as ready for review June 27, 2024 14:38
@ThibaultFy ThibaultFy requested a review from a team as a code owner June 27, 2024 14:38
@SdgJlbl
Copy link
Contributor

SdgJlbl commented Jun 27, 2024

I'm not sure to have enough context to understand why we need a separate github action for that.
Would this workflow then be called by gh during the release script?

@ThibaultFy
Copy link
Member Author

I'm not sure to have enough context to understand why we need a separate github action for that. Would this workflow then be called by gh during the release script?

Yes the context is quite hard to explain... I'm trying to do a fully distant release proces. The idea is to avoid to have to clone the repo and ensure you have to changes etc... The idea would be to trigger this workflow with the PyGithub API (equivalent to gh) as you said. And the towncrier step is a "non github step" so the only way I found to be able to run it through a github command is creating a workflow... Happy to discuss it if you have any suggestion !

@ThibaultFy ThibaultFy closed this Jul 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants