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

[GH Request] Maintainership for enterprise repos #1352

Closed
bcitro opened this issue Jan 13, 2025 · 12 comments
Closed

[GH Request] Maintainership for enterprise repos #1352

bcitro opened this issue Jan 13, 2025 · 12 comments
Assignees
Labels
github-request Request for change to access level or settings in the openedx GitHub organization.

Comments

@bcitro
Copy link

bcitro commented Jan 13, 2025

Firm Name

2U

Urgency

Medium (< 2 weeks)

Requested Change

The 2U enterprise team would like to take on maintainership responsibilities for the enterprise-specific openedx repos (specified below). Please let me know next steps for making this happen.

There are currently four github teams (corresponding to the 2U enterprise engineering teams) that would need to have maintainer permissions for every repo listed. I would propose creating a new github team called 2u-enterprise, which is comprised of the following teams:

2u-iris
2u-markhors
2u-quokkas
2u-titans

Also - the 2u-quokkas team needs to add two members which are currently missing. Their github usernames are:
katrinan029
jesperhodge

Enterprise repos for maintainership:

  • edx-enterprise
  • edx-enterprise-data
  • edx-enterprise-subsidy-client
  • enterprise-access
  • enterprise-catalog
  • enterprise-subsidy
  • frontend-app-admin-portal
  • frontend-app-enterprise-public-catalog
  • frontend-app-learner-portal-enterprise
  • frontend-enterprise
  • license-manager
  • openedx-ledger
  • taxonomy-connector

Reasoning

Two main reasons:

  1. This will allow 2U enterprise teams to maintain write access to the repos listed after the changes from this document are implemented: https://docs.google.com/spreadsheets/d/1li0HLco8BlHiWoG7oGdslbqeMirgp11nRDNrJsHY5n8/edit?gid=1897338731#gid=1897338731
  2. The 2U enterprise teams have already been unofficially maintaining these repos for some time, so this will make it official.
@bcitro bcitro added the github-request Request for change to access level or settings in the openedx GitHub organization. label Jan 13, 2025
Copy link

Thank you for your report! @openedx/axim-oncall will triage within a business day. Simple requests usually take 2-3 business days to resolve; more complex requests could take longer.

@bmtcril bmtcril self-assigned this Jan 13, 2025
@bmtcril bmtcril moved this from Backlog to In Progress in Axim Engineering Tasks Jan 14, 2025
@bmtcril
Copy link
Contributor

bmtcril commented Jan 14, 2025

@bcitro a couple of questions for you

  • Is there a reason to keep the other 4 teams around after this set of changes? It will make things more complicated to manage from our end and doesn't seem super useful if everyone has the same permissions. We don't use sub-teams for permissions as they don't allow us an appropriate level of visibility, so we'd be adding and removing users from sub-teams and the parent 2u-enterprise team manually, making for a somewhat error prone process.
  • Maintainer permissions are just push/pull permissions, actual maintainership tracking is handled via the catalog-info.yaml file in each repo so your teams will need to update those once the new team is created.

Here are my proposed steps, let me know what you think:

  • Create the 2u-enterprise team
  • Move all users from the existing 4 teams to 2u-enterprise, as well as katrinan029 and jesperhodge if they aren't in other teams
  • Delete the old teams
  • Grant write access to all of the above repositories to 2u-enterprise
  • Someone from 2u-enterprise updates catalog-info.yaml in each repository to update maintainership

If that sounds good to you and the rest of the @openedx/axim-engineering team here I should be able to do it today.

@bmtcril bmtcril moved this from In Progress to Blocked in Axim Engineering Tasks Jan 14, 2025
@bcitro
Copy link
Author

bcitro commented Jan 14, 2025

Hi @bmtcril - thank you for the quick reply!

That proposal works well for us. One potential minor complication - the 2u-iris team is already set as maintainers in the enterprise-integrated-channels repo. So we'd probably want to update that to 2u-enterprise after that group is created, but before we delete the 2u-iris group. Otherwise this all sounds great!

@bmtcril bmtcril moved this from Blocked to In Progress in Axim Engineering Tasks Jan 14, 2025
@bmtcril
Copy link
Contributor

bmtcril commented Jan 14, 2025

@bcitro I don't think there are any bad effects of having the the owner in enterprise-integrated-channels be incorrect temporarily, but I'm about to start these changes by creating the new group now if anyone wants to push through that change.

@bmtcril
Copy link
Contributor

bmtcril commented Jan 14, 2025

Ok @bcitro I've created the new team, added folks, and the permissions. If you want to confirm membership, I think you can check here: https://github.com/orgs/openedx/teams/2u-enterprise/members and repositories here: https://github.com/orgs/openedx/teams/2u-enterprise/repositories

In looking at the existing teams, only 2u-iris has repositories associated with them so I'm guessing that the others are used for code ownership / requesting reviews. I can leave them if that's a thing you all would like to keep, though I'd like to remove the repository permissions from the 2u-iris team. Right now, in addition to the repositories you listed the iris team also grants access to:

  • course-discovery
  • edx-platform

If those users still need access to those repositories we can figure a way to add them to appropriate teams, if not I can just remove all of the existing repository permissions. Let me know how you'd like to proceed!

@bcitro
Copy link
Author

bcitro commented Jan 15, 2025

@bmtcril Awesome, thanks!

Apologies, but there are two members I missed that need to be added to 2u-enterprise. Their github usernames are:

  • mahamakifdar19
  • jajjibhai008

I don't think we need to keep the old teams at this point, we can handle everything through the new 2u-enterprise team.

For 2u-iris repo permissions:

  • They do not need to maintain access to course-discovery, so no need for action there
  • They do need to maintain access to edx-platform. That has been noted in a comment in this spreadsheet . So whatever the plan is to maintain that access should be fine.

I will get started coordinating the creation of the catalog-info.yaml files for the enterprise repos.

Thanks again for your help with all of this!

@bcitro
Copy link
Author

bcitro commented Jan 15, 2025

Sorry - also just noticed that https://github.com/openedx/enterprise-integrated-channels is only under 2u-iris, can we add that to the list for 2u-enterprise as well? Thanks!

@bmtcril
Copy link
Contributor

bmtcril commented Jan 15, 2025

I've added enterprise-integrated-channels to 2u-enterprise, sorry for the miss. Also added mahamakifdar19
and jajjibhai008 to the team. The former iris team members have been added to the edx-platform committers team as well, so their permissions should only change in the loss of course-discovery direct commit permissions.

The following teams have been deleted:
2u-iris
2u-markhors
2u-quokkas
2u-titans

I think this is done now, aside from the catalog-info updates, so I'm going to close it out but feel free to re-open or ping me if there are any issues!

@bmtcril bmtcril closed this as completed Jan 15, 2025
@github-project-automation github-project-automation bot moved this from In Progress to Done in Axim Engineering Tasks Jan 15, 2025
@bcitro
Copy link
Author

bcitro commented Jan 15, 2025

@bmtcril Hopefully last thing! Looks like enterprise-integrated-channels was added with Read permission, we need Write permission to that repo. Thanks!

@bmtcril
Copy link
Contributor

bmtcril commented Jan 15, 2025

All set, thanks!

@feanil
Copy link
Contributor

feanil commented Jan 17, 2025

@bcitro please update or add catalog-info.yaml files to all the repos where you wish to be the maintainer as soon as possible to retain access, we're in a bit of a transition state this next couple of weeks and making sure the catalog files are up-to-date will reduce that chance that we accidentally revert access.

@bcitro
Copy link
Author

bcitro commented Jan 17, 2025

@feanil thanks for the nudge, I've added/updated the catalog-info.yaml files for all repos. Just FYI - we are planning to spend more time ASAP getting these files cleaned up/fleshed out (as well as running through the rest of this list of requirements for maintainers), but for now I focused only on getting the owner field set correctly.

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
github-request Request for change to access level or settings in the openedx GitHub organization.
Projects
Status: Done
Development

No branches or pull requests

3 participants