1795071 - Introduce a better strategy for adding A-C changelog entries

Status: NEW

(Firefox for Android :: General, task)

Description

[Christian Sadilek [:csadilek]]

From github: https://github.com/mozilla-mobile/android-components/issues/7816.

This is following a discussion on Slack about conflicts in PRs when editing the changelog.

In order to reduce friction when submitting a PR, we run into issues where a changelog entry has conflicts from multiple editos

The idea is solve issues around adding a changelog entry:

• Reduce the friction for contributors that want to submit a patch but now require to fix conflicts in the patch because of conflicts from a changelog by another PR having recently merged.
• Changelog entries sometimes end up under the wrong release. This usually happens when an entry was added under a version X, followed by a release for X, a new version Y is added, the PR entry lands under version X instead of Y.
• It's easy to forget adding a changelog entry when first publishing your changes. The checklist in our PR template is a good reminder to do this, but requires you to re-push again to add an entry.
• Adding meaningful changelog entries - this isn't a quantitative issue: changelog entries can be more meaningful with more examples of code changes .

Some possible solutions discussed:

• Add a pre-push hook to check if a public API has changed, and fail the push if an edit to the docs/changelog.md was not added.
• Add a build script that extracts a section from a PR format in the opening Pull Request comment that will added to the changelog as part of a pre-merge step from bors.

┆Issue is synchronized with this Jira Task

Change performed by the Move to Bugzilla add-on.