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 web engineering to the CODEOWNERS file for website tooling, but not content. #29418

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

judithpatudith
Copy link
Contributor

Description

This PR should let the web presence team get notified about changes to our documentation tooling under the website folder, but not about content changes. @schavis I'd love help with backport labels and am glad for any other corrections you have!

TODO only if you're a HashiCorp employee

  • Backport Labels: If this fix needs to be backported, use the appropriate backport/ label that matches the desired release branch. Note that in the CE repo, the latest release branch will look like backport/x.x.x, but older release branches will be backport/ent/x.x.x+ent.
    • LTS: If this fixes a critical security vulnerability or severity 1 bug, it will also need to be backported to the current LTS versions of Vault. To ensure this, use all available enterprise labels.
  • ENT Breakage: If this PR either 1) removes a public function OR 2) changes the signature
    of a public function, even if that change is in a CE file, double check that
    applying the patch for this PR to the ENT repo and running tests doesn't
    break any tests. Sometimes ENT only tests rely on public functions in CE
    files.
  • Jira: If this change has an associated Jira, it's referenced either
    in the PR description, commit message, or branch name.
  • RFC: If this change has an associated RFC, please link it in the description.
  • ENT PR: If this change has an associated ENT PR, please link it in the
    description. Also, make sure the changelog is in this PR, not in your ENT PR.

@judithpatudith judithpatudith requested a review from a team as a code owner January 25, 2025 00:43
@github-actions github-actions bot added the hashicorp-contributed-pr If the PR is HashiCorp (i.e. not-community) contributed label Jan 25, 2025
Copy link

github-actions bot commented Jan 25, 2025

CI Results:
All Go tests succeeded! ✅

Copy link

github-actions bot commented Jan 25, 2025

Build Results:
All builds succeeded! ✅

CODEOWNERS Outdated

# Engineering and web presence get notified of, and can approve changes to web tooling, but not content.

/website/ @hashicorp/web-presence @hashicorp/vault
Copy link
Contributor

Choose a reason for hiding this comment

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

Why are we adding @hashicorp/vault as an owner for files under /website/ and the content-specific folders below?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

My reasoning was that we would want the engineering team to have complete control over their own repo, in case (and I know this is very unlikely) there was a problem in one of these files that blocked a release or some other emergency. I don't think we explicitly exclude these directories from CI and release tooling, so I just want to make sure there's nothing in here that engineering couldn't fix on their own in a pinch.

CODEOWNERS Outdated
Comment on lines 44 to 46
/website/data/ @hashicorp/vault-education-approvers @hashicorp/vault
/website/public/ @hashicorp/vault-education-approvers @hashicorp/vault
/website/content/ @hashicorp/vault-education-approvers @hashicorp/vault
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
/website/data/ @hashicorp/vault-education-approvers @hashicorp/vault
/website/public/ @hashicorp/vault-education-approvers @hashicorp/vault
/website/content/ @hashicorp/vault-education-approvers @hashicorp/vault
/website/data/ @hashicorp/vault-education-approvers @hashicorp/vault
/website/public/ @hashicorp/vault-education-approvers @hashicorp/vault
/website/content/ @hashicorp/vault-education-approvers @hashicorp/vault
/website/templates/ @hashicorp/vault-education-approvers @hashicorp/vault

I'm leaving the @hashicorp/vault references for now, but I don't think it's appropriate. If specific teams what notifications for docs related to their work, I understand that, but making all of Vault owners for the docs will create a lot of extra GitHub noise and also allow folks to bypass EDU review for doc changes.

@schavis
Copy link
Contributor

schavis commented Jan 30, 2025

I'd love help with backport labels

1.18 is the only relevant backport label at the moment. If you haven't merged before the RC cut for 1.19, you'll want to add that one as well. If we want to push the changes beyond 1.18, we'll have to backport it manually (I'm happy to help with that)

@judithpatudith
Copy link
Contributor Author

If you could shepherd it that would be amazing! Also to your point about noise above, if Vault eng explicitly doesn't want to be on these directories I'm ok with removing them. It just felt a bit icky to me for them not to have control of any PR in their repo, which is why they're there.

@schavis
Copy link
Contributor

schavis commented Jan 30, 2025

If you could shepherd it that would be amazing!
👍🏽

Also to your point about noise above, if Vault eng explicitly doesn't want to be on these directories I'm ok with removing them. It just felt a bit icky to me for them not to have control of any PR in their repo, which is why they're there.

That's my understanding from general conversation, but I've pinged in the Vault team channel to get feedback on that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/1.18.x hashicorp-contributed-pr If the PR is HashiCorp (i.e. not-community) contributed pr/no-changelog pr/no-milestone
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants