-
-
Notifications
You must be signed in to change notification settings - Fork 693
Automated the generation of changelogs in text format #39024
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
Conversation
This workflow in turn triggeres changelog generator workflow on website repo
|
Documentation preview for this PR (built with commit 72d1e6d; changes) is ready! 🎉 |
…o 'WEBSITE_ACCESS_TOKEN'
sagemathgh-39024: Automated the generation of changelogs in text format <!-- ^ Please provide a concise and informative title. --> <!-- ^ Don't put issue numbers in the title, do this in the PR description below. --> <!-- ^ For example, instead of "Fixes sagemath#12345" use "Introduce new method to calculate 1 + 2". --> <!-- v Describe your changes below in detail. --> <!-- v Why is this change required? What problem does it solve? --> <!-- v If this PR resolves an open issue, please link to it here. For example, "Fixes sagemath#12345". --> Associated with [sagemath#480 on website repo](sagemath/website#480) This pull request defines a workflow which is executed when any release is published. It in turn triggers the execution of `Generate Changelog` workflow in [website repo](https://github.com/sagemath/website) and the changelog is generated in .txt format if the current release was a stable release. ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. --> - [x] The title is concise and informative. - [x] The description explains in detail what this PR is about. - [x] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. - [ ] I have updated the documentation and checked the documentation preview. <!-- ### ⌛ Dependencies --> <!-- List all open PRs that this PR logically depends on. For example, --> <!-- - sagemath#12345: short description why this is a dependency --> <!-- - sagemath#34567: ... --> URL: sagemath#39024 Reported by: Soham Rane Reviewer(s): Kwankyu Lee, Soham Rane
|
This PR is complemented by #39083. |
sagemathgh-39024: Automated the generation of changelogs in text format <!-- ^ Please provide a concise and informative title. --> <!-- ^ Don't put issue numbers in the title, do this in the PR description below. --> <!-- ^ For example, instead of "Fixes sagemath#12345" use "Introduce new method to calculate 1 + 2". --> <!-- v Describe your changes below in detail. --> <!-- v Why is this change required? What problem does it solve? --> <!-- v If this PR resolves an open issue, please link to it here. For example, "Fixes sagemath#12345". --> Associated with [sagemath#480 on website repo](sagemath/website#480) This pull request defines a workflow which is executed when any release is published. It in turn triggers the execution of `Generate Changelog` workflow in [website repo](https://github.com/sagemath/website) and the changelog is generated in .txt format if the current release was a stable release. ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. --> - [x] The title is concise and informative. - [x] The description explains in detail what this PR is about. - [x] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. - [ ] I have updated the documentation and checked the documentation preview. <!-- ### ⌛ Dependencies --> <!-- List all open PRs that this PR logically depends on. For example, --> <!-- - sagemath#12345: short description why this is a dependency --> <!-- - sagemath#34567: ... --> URL: sagemath#39024 Reported by: Soham Rane Reviewer(s): Kwankyu Lee, Soham Rane
|
It seems that the workflow is not triggered by a release. |
|
I expected that the workflow itself runs but the steps are skipped for pre-releases. Of course, it is okay that the workflow does not run for pre-releases. Let's wait and see what happens for a stable release. |
|
Yes, ideally the workflow should have run and the steps should have been skipped |
|
The workflow https://github.com/sagemath/sage/actions/workflows/changelog_trigger.yml does not run even for a stable release... |
|
Perhaps would work? |
|
My LLM also suggested something similar. GitHub’s behavior around this seems a bit flaky, so I’m all for trying |
Yes. Though I don't remember clearly, I must have also tested it successfully on my own repo. Strange..
Thanks for the tips. Let's pass one more release with If that fails, we pass the next release with If that still fails, we use Let's see. Thanks. |
|
I just found why the workflow does not run on a new release. To summarize: because the release (event) is made by a workflow with GITHUB_TOKEN, the release event does not trigger another workflow (to prevent accidental infinite loop). The article also tells a solution. I will prepare a PR soon. |
sagemathgh-40654: Fix release workflow to trigger changelog workflow <!-- ^ Please provide a concise and informative title. --> <!-- ^ Don't put issue numbers in the title, do this in the PR description below. --> <!-- ^ For example, instead of "Fixes sagemath#12345" use "Introduce new method to calculate 1 + 2". --> <!-- v Describe your changes below in detail. --> <!-- v Why is this change required? What problem does it solve? --> <!-- v If this PR resolves an open issue, please link to it here. For example, "Fixes sagemath#12345". --> Fixes sagemath#39024 (comment). For why, see sagemath#39024 (comment) To see if this works well, after merged, we can just watch https://github.com/sagemath/website/actions/workflows/generate_changelog .yml after the next stable release. ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. --> - [x] The title is concise and informative. - [x] The description explains in detail what this PR is about. - [x] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. - [ ] I have updated the documentation and checked the documentation preview. ### ⌛ Dependencies <!-- List all open PRs that this PR logically depends on. For example, --> <!-- - sagemath#12345: short description why this is a dependency --> <!-- - sagemath#34567: ... --> URL: sagemath#40654 Reported by: Kwankyu Lee Reviewer(s): Kwankyu Lee, Tobias Diez, user202729
Associated with #480 on website repo
This pull request defines a workflow which is executed when any release is published.
It in turn triggers the execution of
Generate Changelogworkflow in website repo and the changelog is generated in .txt format if the current release was a stable release.📝 Checklist