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

Add pre-release notes ci job #151

Open
ZLLentz opened this issue Oct 1, 2024 · 2 comments
Open

Add pre-release notes ci job #151

ZLLentz opened this issue Oct 1, 2024 · 2 comments

Comments

@ZLLentz
Copy link
Member

ZLLentz commented Oct 1, 2024

Some of our Python packages require the user to add some release notes to each PR

There must be some way we can enshrine this in ci

  • Fail if there's no release notes file?
  • Fail if a release notes file is added, but it doesn't have any contributors?
  • Fail if the contributors list doesn't include the user's github username?
@tangkong
Copy link
Contributor

tangkong commented Oct 1, 2024

I think it shouldn't go in pre-commit hooks, since we probably can't / shouldn't require pre-release notes to exist at every commit at every point in the branch.

A small ci helper job seems like the right place for this though.

Now as for the actual checking of github usernames etc, that's another problem to be solved. Maybe this can also attempt to validate the rst or something? (I guess formatting will just look ugly but not error, most of the time)

@ZLLentz ZLLentz transferred this issue from pcdshub/pre-commit-hooks Oct 1, 2024
@ZLLentz ZLLentz changed the title Add pre-release notes pre-commit-hook Add pre-release notes ci job Oct 1, 2024
@ZLLentz
Copy link
Member Author

ZLLentz commented Oct 1, 2024

Moved from pre commit repo to ci helpers repo and changed the wording to match

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

No branches or pull requests

2 participants