-
Notifications
You must be signed in to change notification settings - Fork 28
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
Improve changelog management #1058
Conversation
As discussed synchronously with @Ndpnt and @clementbiron, the current implementation has the following limitations:
An alternative could be to offer a line to copy-paste in the
|
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.
(partial review)
Co-authored-by: Matti Schneider <matti@opentermsarchive.org>
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.
Almost there, but the checks and the option syntax should be corrected.
scripts/changelog/changelog.js
Outdated
import ChangelogValidationError from './changelogValidationError.js'; | ||
|
||
export default class Changelog { | ||
static FUNDER_REGEX = /^> Development of this release was(.+)$/m; |
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.
- Follow the spec.
- Ensure there is a closing full stop.
- Why allow multiline?
static FUNDER_REGEX = /^> Development of this release was(.+)$/m; | |
static FUNDER_REGEX = /^> Development of this release was supported by (.+)\.$/; |
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.
- Multiline is required to have
^
and$
to match the begin/end of each line (not only begin/end of string). This is essential as we analyze the entire release content to verify the funder. - We have an issue with the specification regarding certain release funders formatted as follows:
> Development of this release was made on a volunteer basis by ….
Should we modify these types of funder sentences, or should we adjust the specification accordingly?
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.
We should adjust the spec as volunteer contributions are an integral part of the contribution workflow.
Gotcha for the multiline, I had misunderstood this flag as valid for the match, not for the input.
Co-authored-by: Matti Schneider <matti@opentermsarchive.org>
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.
👏 🚀
scripts/changelog/changelog.js
Outdated
@@ -4,7 +4,7 @@ import semver from 'semver'; | |||
import ChangelogValidationError from './changelogValidationError.js'; | |||
|
|||
export default class Changelog { | |||
static FUNDER_REGEX = /^> Development of this release was(.+)$/m; | |||
static FUNDER_REGEX = /^> Development of this release (?:was supported by|was made on a volunteer basis by)(.+)\.$/m; |
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.
static FUNDER_REGEX = /^> Development of this release (?:was supported by|was made on a volunteer basis by)(.+)\.$/m; | |
static FUNDER_REGEX = /^> Development of this release was (?:supported by|made on a volunteer basis by)(.+)\.$/m; |
Unreleased
sectionUnreleased
section title after releasing a versionRemove dependency to external GitHub Action superfaceai/release-changelog-action
Fixes #1009