Skip to content
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

actions: check shortlog #4205

Merged
merged 5 commits into from
Jun 10, 2021
Merged

actions: check shortlog #4205

merged 5 commits into from
Jun 10, 2021

Conversation

oliver-sanders
Copy link
Member

Add an action which checks that all commits are identified with committers in the contributors log via configured aliases in the .mailmap file whenever the CHANGELOG.md file is edited.

We could potentially run this for every PR, however, it requires checking out the entire repo[1].

Fixes some minor discrepancies.

[1]: There is a potential halfway house of checking out the last N commits then testing that those commuters exist in the contributing file rather than testing exact equality but this is starting to sound like more bother than it's worth.

Requirements check-list

  • I have read CONTRIBUTING.md and added my name as a Code Contributor.
  • Contains logically grouped changes (else tidy your branch by rebase).
  • Does not contain off-topic changes (use other PRs for other changes).
  • Applied any dependency changes to both setup.py and
    conda-environment.yml.
  • Appropriate tests are included (unit and/or functional).
  • Already covered by existing tests.
  • Does not need tests (why?).
  • Appropriate change log entry included.
  • No change log entry required (why? e.g. invisible to users).
  • No documentation update required.

@oliver-sanders oliver-sanders added this to the cylc-8.0b2 milestone May 6, 2021
@oliver-sanders oliver-sanders self-assigned this May 6, 2021
@oliver-sanders oliver-sanders removed the request for review from MetRonnie May 6, 2021 15:53
@oliver-sanders
Copy link
Member Author

May have to use ${{ github.sha }} rather than ${{ github.ref }}, not sure.

.github/workflows/shortlog.yml Outdated Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
@oliver-sanders
Copy link
Member Author

oliver-sanders commented May 11, 2021

github.sha seems to work fine, just tweeking the mailmap to fix the last error.

@oliver-sanders oliver-sanders force-pushed the shortlog branch 2 times, most recently from 6680d19 to 2455057 Compare May 11, 2021 10:29
@oliver-sanders oliver-sanders marked this pull request as ready for review May 11, 2021 10:31
@oliver-sanders oliver-sanders marked this pull request as draft May 11, 2021 10:31
* fix mailmap file
@oliver-sanders
Copy link
Member Author

Switched to running from cylc/release-actions.

@oliver-sanders
Copy link
Member Author

Added contributor check to the stage 1 workflow.

@oliver-sanders oliver-sanders marked this pull request as ready for review May 12, 2021 08:54
Co-authored-by: Ronnie Dutta <61982285+MetRonnie@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants