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

contributing: Hide bots from release notes #3829

Merged
merged 1 commit into from
Jun 15, 2024

Conversation

wenzeslaus
Copy link
Member

This hides all changes by recognized bots from release notes. The changes may still be relevant, e.g., change of version of dependency in a Docker image, so they are hidden but discoverable using Markdown details HTML tag.

Additionally, to make the release notes shorter, this shows only 20 items and hides the rest together with the changes from bots. The overflowing changes are printed first, then the ones from bots. Each group is sorted alphabetically.

This hides all changes by recognized bots from release notes. The changes may still be relevant, e.g., change of version of dependency in a Docker image, so they are hidden but discoverable using Markdown details HTML tag.

Additionally, to make the release notes shorter, this shows only 20 items and hides the rest together with the changes from bots. The overflowing changes are printed first, then the ones from bots. Each group is sorted alphabetically.
@wenzeslaus
Copy link
Member Author

An example how this looks like:

image

@wenzeslaus wenzeslaus requested a review from neteler June 15, 2024 13:07
Copy link
Member

@neteler neteler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great approach!

@github-actions github-actions bot added the Python Related code is in Python label Jun 15, 2024
@neteler neteler added this to the 8.4.0 milestone Jun 15, 2024
@wenzeslaus wenzeslaus merged commit eb39403 into OSGeo:main Jun 15, 2024
27 checks passed
@wenzeslaus wenzeslaus deleted the hide-bots-from-release-notes branch June 15, 2024 15:36
neteler pushed a commit that referenced this pull request Jun 16, 2024
This hides all changes by recognized bots from release notes. The changes may still be relevant, e.g., change of version of dependency in a Docker image, so they are hidden but discoverable using Markdown details HTML tag.

Additionally, to make the release notes shorter, this shows only 20 items and hides the rest together with the changes from bots. The overflowing changes are printed first, then the ones from bots. Each group is sorted alphabetically.
a0x8o pushed a commit to a0x8o/grass that referenced this pull request Jun 17, 2024
This hides all changes by recognized bots from release notes. The changes may still be relevant, e.g., change of version of dependency in a Docker image, so they are hidden but discoverable using Markdown details HTML tag.

Additionally, to make the release notes shorter, this shows only 20 items and hides the rest together with the changes from bots. The overflowing changes are printed first, then the ones from bots. Each group is sorted alphabetically.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Python Related code is in Python
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants