Skip to content

[skip changelog] Add skip changelog prefix to Dependabot workflow update commits #1381

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

Merged
merged 1 commit into from
Aug 9, 2021
Merged

[skip changelog] Add skip changelog prefix to Dependabot workflow update commits #1381

merged 1 commit into from
Aug 9, 2021

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented Aug 9, 2021

Please check if the PR fulfills these requirements

  • The PR has no duplicates (please search among the Pull Requests
    before creating one)
  • The PR follows
    our contributing guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • UPGRADING.md has been updated with a migration guide (for breaking changes)
  • What kind of change does this PR introduce?

Infrastructure enhancement

  • What is the current behavior?

Dependabot is configured to submit pull requests for updates to the GitHub Actions actions used in the repository's workflows whenever a new version is available. These commits will create entries in the automatically generated draft changelog, but will not result in any user facing changes and so have no place there. The release manager's time will be wasted by cleaning them out of the raw changelog.

  • What is the new behavior?

The message title of the commits generated by Dependabot will be prefixed with "[skip changelog]":
https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates#commit-message

The changelog generation system automatically excludes any commit that has this prefix.

Does this PR introduce a breaking change

No

is titled accordingly

Yes

…ate commits

Dependabot is configured to submit pull requests for updates to the GitHub Actions actions used in the repository's
workflows whenever a new version is available. These commits will not result in any user facing changes and so should not
be mentioned in the release changelog.

The changelog generation system automatically excludes any commit that has the `[skip changelog]` prefix on its message
title. Adding this changelog to the commits generated by Dependabot will save the release manager time when cleaning up
the raw changelog.
@per1234 per1234 added type: enhancement Proposed improvement topic: infrastructure Related to project infrastructure labels Aug 9, 2021
@per1234 per1234 requested review from silvanocerza and umbynos August 9, 2021 11:26
@per1234 per1234 merged commit 4fbf7b7 into arduino:master Aug 9, 2021
@per1234 per1234 deleted the dependabot-prefix branch August 9, 2021 13:08
per1234 added a commit that referenced this pull request Aug 12, 2021
…flow update commits (#1381)" (#1389)

This reverts commit 4fbf7b7.

It turns out there is an undocumented maximum length of 15 characters for this prefix:

https://github.com/arduino/arduino-cli/network/updates

```
Dependabot encountered the following error when parsing your .github/dependabot.yml:

The property '#/updates/0/commit-message/prefix' was not of a maximum string length of 15
Please update the config file to conform with Dependabot's specification.
```
Unfortunately, even though it is possible to reduce the prefix length by 1 with the removal of the trailing space, we
still end up with 16 characters.
@per1234 per1234 self-assigned this Nov 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: infrastructure Related to project infrastructure type: enhancement Proposed improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants