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

[PM-14880] Add release notes config #4295

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

[PM-14880] Add release notes config #4295

wants to merge 2 commits into from

Conversation

vvolkgang
Copy link
Member

@vvolkgang vvolkgang commented Nov 12, 2024

🎟️ Tracking

https://bitwarden.atlassian.net/browse/PM-14880

📔 Objective

Adds a configuration file for GitHub automated release notes, as an first iteration to test this functionality. This won't be the final version of this file, as we need to test how the functionality reacts to misconfiguration.

⏰ Reminders before review

  • Contributor guidelines followed
  • All formatters and local linters executed and passed
  • Written new unit and / or integration tests where applicable
  • Used internationalization (i18n) for all UI strings
  • CI builds passed
  • Communicated to DevOps any deployment requirements
  • Updated any necessary documentation or informed the documentation team

🦮 Reviewer guidelines

  • 👍 (:+1:) or similar for great changes
  • 📝 (:memo:) or ℹ️ (:information_source:) for notes or general info
  • ❓ (:question:) for questions
  • 🤔 (:thinking:) or 💭 (:thought_balloon:) for more open inquiry that's not quite a confirmed
    issue and could potentially benefit from discussion
  • 🎨 (:art:) for suggestions / improvements
  • ❌ (:x:) or ⚠️ (:warning:) for more significant problems or concerns needing attention
  • 🌱 (:seedling:) or ♻️ (:recycle:) for future improvements or indications of technical debt
  • ⛏ (:pick:) for minor or nitpick changes

Copy link

codecov bot commented Nov 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.01%. Comparing base (e804dbd) to head (0d55d0d).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #4295   +/-   ##
=======================================
  Coverage   89.01%   89.01%           
=======================================
  Files         453      453           
  Lines       39064    39064           
  Branches     5482     5482           
=======================================
  Hits        34771    34771           
  Misses       2369     2369           
  Partials     1924     1924           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

github-actions bot commented Nov 12, 2024

Logo
Checkmarx One – Scan Summary & Details7d14d22b-cff4-4785-bde1-24b09b7d3c8e

No New Or Fixed Issues Found

@vvolkgang vvolkgang added the ci/cd Updates to automated workflows label Nov 13, 2024
Comment on lines +23 to +24
authors:
- renovate[bot]
Copy link
Member

Choose a reason for hiding this comment

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

⚠️ From what I can see in the docs authors is only available in exclude section => changelog.categories[*].exclude.authors; so I think this config won't work or do anything.
Additionally, maybe we could have PRs created by renovate[bot] automatically have one of the labels listed below so to be added to this category.

Comment on lines +7 to +12
- title: ':tada: Exciting New Features'
labels:
- '*'
exclude:
authors:
- renovate[bot]
Copy link
Member

Choose a reason for hiding this comment

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

🤔 Shouldn't we exclude the labels of the other categories here? So e.g. a PR labeled with bug is not listed as an exciting new feature.

Copy link
Member Author

@vvolkgang vvolkgang Nov 13, 2024

Choose a reason for hiding this comment

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

This applies to the other comments too, all of these were put in place to test how their implementation reacts to misconfiguration. I'll update the description to note that.

Comment on lines +28 to +30
- tests-only
- refactor
- tests-only
Copy link
Member

Choose a reason for hiding this comment

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

⛏️ tests-only is repeated.
🤔 I see tests-only excluded in the exclude top section, which one takes precedence?

@vvolkgang vvolkgang marked this pull request as draft November 13, 2024 15:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci/cd Updates to automated workflows
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants