-
Notifications
You must be signed in to change notification settings - Fork 3
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 changelog-existence workflow #7
base: main
Are you sure you want to change the base?
Conversation
@@ -0,0 +1,106 @@ | |||
# **what?** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should go into a README
type: string | ||
required: true | ||
|
||
jobs: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should this be a composite action instead of a workflow? Can you show an example how it would be used, or open a PR in another repo showing that?
comment-author: 'github-actions[bot]' | ||
body-includes: ${{ inputs.changelog_comment }} | ||
|
||
- name: Set if comment already exists |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this step necessary? Looks like it maps the output of the previous step into a different name.
if: | | ||
steps.changelog_check.outputs.exists == 'false' && | ||
steps.comment_check.outputs.exists == 'false' | ||
uses: peter-evans/create-or-update-comment@v1 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does this work on PRs from forks?
# changelog: | ||
# uses: dbt-labs/actions/.github/workflows/changelog-check.yml@main | ||
# with: | ||
# changelog_comment: 'Thank you for your pull request! We could not find a changelog entry for this change. For details on how to document a change, see [the contributing guide](https://github.com/dbt-labs/dbt-core/blob/main/CONTRIBUTING.md#adding-changelog-entry).' |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So this requires installing yet another program. This increases the learning curve for new contributors. There should at least be a setting to make this optional and not fail the pipeline.
Are there alternatives? Github can automatically generate a change log when creating a new release: https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes Can you see how it compares to changie?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Any change which adds burden on contributors is a no-go in my opinion.
An alternative is an implemenation like in trinodb/charts which the contributor doesn't have to worry about or what Manfred is proposing in another PR.
Within dbt-trino we are using
changie
to create changelog entries.changie
offers following features:changie new
with configurable entries.See https://changie.dev/
We would like to do the same for trino-python-client and eventually trino.