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 an explicit Chronographer config #11848

Merged
merged 1 commit into from
Mar 12, 2023

Conversation

webknjaz
Copy link
Member

@webknjaz webknjaz commented Mar 8, 2023

In particular, this allows setting up hints for leading the
contributors to the docs that explain the changelog fragments
expectations. This allows having the preferences documented as code.

The patch also sets the label for ignoring the change note
requirement.

@webknjaz webknjaz requested a review from pradyunsg March 8, 2023 13:28
@webknjaz webknjaz added skip news Does not need a NEWS file entry (eg: trivial changes) C: automation Automated checks, CI etc type: maintenance Related to Development and Maintenance Processes labels Mar 8, 2023
@webknjaz
Copy link
Member Author

webknjaz commented Mar 8, 2023

@pradyunsg feel free to edit out the undesired stuff. This adds configs for some of your earlier requests.

@webknjaz webknjaz force-pushed the maintenance/chronographer-config branch from b174b1b to 91d42e6 Compare March 9, 2023 01:12
In particular, this allows setting up hints for leading the
contributors to the docs that explain the changelog fragments
expectations. This allows having the preferences documented as code.

The patch also sets the label for ignoring the change note
requirement.
@pfmoore
Copy link
Member

pfmoore commented Mar 12, 2023

Can someone provide some background on what this is, and how it affects the project? The PR doesn't include any changes to the docs - does that mean the development workflow is unaffected?

@webknjaz
Copy link
Member Author

@pfmoore it's a replacement for the towncrier fragment check implemented as a GitHub App as opposed to a GHA workflow. It's a partial derivative of browntruck. This is the config for said app. It's been in use in various GH orgs since 2019 but I originally started the project because Pradyun asked me to explore refactoring the legacy webhook based integration. We got back to checking how ready the app was once in a while, Pradyun asked for more toggles and they are finally in place.

The earlier proposal was here: #6475.

Your workflow will not change thanks to the recent updates allowing to have a custom label name but the check result may look a bit different.
The GHA workflow is still in place to allow some time for comparison — so you'll see two checks being reported until it's removed. This will let us see if there's anything else people are missing from this integration.
Also, the GitHub App can be suspended at any time in the repo/org settings. This is what Pradyun did when we first installed it but realized that a few more changes were needed.

I've just retriggered the check on another PR, you can see it here: #11861.

@pfmoore
Copy link
Member

pfmoore commented Mar 12, 2023

Cool, thanks for the explanation!

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 28, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
C: automation Automated checks, CI etc skip news Does not need a NEWS file entry (eg: trivial changes) type: maintenance Related to Development and Maintenance Processes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants