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

Adjust handling of GH action dependencies for CI/CD partnership #5274

Merged
merged 1 commit into from
Jan 15, 2025

Conversation

trmartin4
Copy link
Member

🎟️ Tracking

bitwarden.atlassian.net/browse/PM-14640

📔 Objective

Analog to bitwarden/clients#12818 on the clients repo.

As we have started to share ownership of our build pipelines between BRE and Platform, BRE no longer owns all of the github-action-managed dependencies. The current renovate.json results in misleading PR titles like bitwarden/clients#12706.

This PR does the following:

  • Removes the addition of the BRE prefix for all github-action dependencies. It is left for dockerfile and docker-compose managers as those are owned by BRE.
  • Removes patch updates from the scope of PR creation.

❓ What will upcoming PRs look like?

  • Patch updates will be ignored
  • Minor workflow dependency updates will be grouped into a single PR, with no team-specific prefix, with the PR reviewer(s) determined by who owns the workflow files in which the dependencies are used (e.g. Platform would need to review build/lint/test workflows, BRE would need to review deploy/publish workflows).
    • 🤔 Note that we can do this since the workflow files have explicit CODEOWNERs defined, whereas other dependencies are updated in package.json which doesn't have an owner, so we have to assign the ownership in renovate.json.
  • Major workflow updates will be handled independently with PRs for each, with no team-specific prefix with the PR reviewer(s) determined by who owns the workflow files in which the dependencies are used

⏰ Reminders before review

  • Contributor guidelines followed
  • All formatters and local linters executed and passed
  • Written new unit and / or integration tests where applicable
  • Protected functional changes with optionality (feature flags)
  • Used internationalization (i18n) for all UI strings
  • CI builds passed
  • Communicated to DevOps any deployment requirements
  • Updated any necessary documentation (Confluence, contributing docs) 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 Jan 15, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 44.02%. Comparing base (ed14f28) to head (307eb6f).
Report is 3 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #5274   +/-   ##
=======================================
  Coverage   44.02%   44.02%           
=======================================
  Files        1476     1476           
  Lines       68291    68291           
  Branches     6175     6175           
=======================================
  Hits        30065    30065           
  Misses      36919    36919           
  Partials     1307     1307           

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

},
{
"groupName": "gh minor",
"groupName": "github-action minor",
Copy link
Contributor

Choose a reason for hiding this comment

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

ℹ️ This is "github action dependencies" on bitwarden/clients#12818.

Copy link
Member Author

Choose a reason for hiding this comment

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

I feel like that github-action minor is actually more descriptive and was going to raise a PR to update the description on clients, since I think this will be the title of the resulting PR (and thus the naming has implications to clarity in the future). Do you have a preference?

Copy link
Contributor

Choose a reason for hiding this comment

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

I like this more, it just wasn't merged yet. Consistency would be great, and you could update the template repo to match.

Copy link
Member Author

Choose a reason for hiding this comment

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

👍 Will do!

Copy link
Member Author

Choose a reason for hiding this comment

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

I updated the clients to match with bitwarden/clients#12896.

Copy link
Contributor

Logo
Checkmarx One – Scan Summary & Details4835155d-dac1-4b99-bfe0-045ac5856c09

Great job, no security vulnerabilities found in this Pull Request

@trmartin4 trmartin4 merged commit b42e4a2 into main Jan 15, 2025
53 checks passed
@trmartin4 trmartin4 deleted the platform/pm-14640/adjust-github-action branch January 15, 2025 20:04
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.

3 participants