87
edits
Changes
Added a quick access section at the top - with all the *common* bug templates listed there, rather than scattered in the doc.added links to the various sections with explanatory material, and links from those sections back to the bugs.
* 2019-02-19 - Mozilla's Code of Conduct is required to be included in every repository, following [[/Repository Requirements|this procedure]].
* 2018-03-29 - new [[/Repository Security|Guidelines for securing sensitive repositories]] published. These are good practices for any repository that does "releases", and some groups my require adherence on their repositories.
== Quick Access for Requests ==
<div id="github_member_bug"></div>
=== I need to be a member of an org ===
Please read [[#join|this]] section on being a member - If you need it, file a bug [https://bugzilla.mozilla.org/enter_bug.cgi?assigned_to=nobody%40mozilla.org&bug_ignored=0&bug_severity=normal&bug_status=NEW&bug_type=task&cf_fx_iteration=---&cf_fx_points=---&comment=I%27ve%20read%20https%3A%2F%2Fwiki.mozilla.org%2FGitHub%23Team_Maintainers_.26_Project_Leads%2C%20and%20need%20help%20adding%20a%20contributor%20to%20the%20org%3A%0D%0A%0D%0AName%3A%20%0D%0AMozilla%20Email%3A%20%0D%0AGithub%20Profile%20link%3A%20%2AStaff%20%2A%2AMUST%2A%2A%20have%20their%20verified%20GitHub%20identity%20listed%20in%20their%20people.m.o%20entry%2A%0D%0AGithub%20Team%28s%29%20%2AREQUIRED%2A%3A%20%0D%0A%0D%0AIf%20this%20is%20not%20being%20requested%20by%20a%20team%20maintainer%2C%20please%20request%20their%20approval%20via%20need-info.&component=Github%3A%20Administration&contenttypemethod=list&contenttypeselection=text%2Fplain&defined_groups=1&filed_via=standard_form&flag_type-4=X&flag_type-607=X&flag_type-800=X&flag_type-803=X&flag_type-936=X&form_name=enter_bug&maketemplate=Remember%20values%20as%20bookmarkable%20template&op_sys=Unspecified&priority=--&product=mozilla.org&qa_contact=cknowles%40mozilla.com&rep_platform=Unspecified&short_desc=Requesting%20GitHub%20membership%20to%20the%20%3CORGNAME%3E%20org%20for%20%3CUSERNAME%3E&target_milestone=---&version=other here] filling out the fields as best you can. Having your manager or maintainer of the team file the bug may short circuit some of the approval processes, and make things go faster.
<div id="github_actions_bug"></div>
=== I want a new action/app added to an org ===
Please read these sections on [[#github_actions|Actions]] and [[#github_apps|Apps]] - file a bug [https://bugzilla.mozilla.org/enter_bug.cgi?comment=I%20want%20to%20use%20the%20NAME_HERE%20addon%20in%20ORG_NAME_HERE%20for%20the%20following%20reasons%3A%0D%0A%0D%0ABelow%20are%20my%20answers%20to%20your%20stock%20questions%3A%0D%0A%0D%0A%2A%2A%20Which%20repositories%20do%20you%20want%20to%20have%20access%3F%20%28all%20or%20list%29%0D%0A%0D%0A%2A%2A%20Are%20any%20of%20those%20repositories%20private%3F%0D%0A%0D%0A%2A%2A%20Provide%20link%20to%20vendor%27s%20description%20of%20permissions%20needed%20and%20why%0D%0A%0D%0A%2A%2A%20Provide%20the%20Install%20link%20for%20a%20GitHub%20app%0D%0A&component=Github%3A%20Administration&product=mozilla.org&short_desc=Assess%20use%20of%20external%20addon%20NAME_HERE%20in%20Mozilla%27s%20GitHub%20organization%20ORG_NAME_HERE bug here], giving us as much information as you can
<div id="github_private_bug"></div>
=== I need a private repo created ===
Please read [[#private|this]] section, and file a bug [https://bugzilla.mozilla.org/enter_bug.cgi?assigned_to=nobody%40mozilla.org&bug_ignored=0&bug_severity=--&bug_status=NEW&bug_type=task&cf_fx_iteration=---&cf_fx_points=---&comment=I%27ve%20read%20all%20of%20the%20%5Brepository%20creation%5D%5B1%5D%20section%2C%20and%20want%20to%20request%20a%20private%20repository.%20I%27ve%20filled%20in%20all%20the%20required%20fields.%0D%0A%0D%0AOrg%20for%20repo%3A%20REQUIRED%0D%0AName%20of%20Repository%3A%20%20REQUIRED%0D%0ALink%20to%20your%20people.m.o%20entry%20with%20verified%20GitHub%20login%3A%20REQUIRED%0D%0A%0D%0A%5BData%20Classification%5D%5B2%5D%20of%20data%20in%20repo%3A%20REQUIRED%0D%0AOther%20business%20justification%20for%20private%20repo%3A%0D%0AWhen%20can%20the%20repository%20be%20made%20public%3F%20REQUIRED%0D%0A%0D%0A%5B1%5D%3A%20https%3A%2F%2Fwiki.mozilla.org%2FGitHub%23Do_I_need_to_be_an_owner_to_create_repositories.3F%0D%0A%5B2%5D%3A%20https%3A%2F%2Fwiki.mozilla.org%2FSecurity%2FData_Classification%0D%0A&component=Github%3A%20Administration&contenttypemethod=list&contenttypeselection=text%2Fplain&defined_groups=1&filed_via=standard_form&flag_type-4=X&flag_type-607=X&flag_type-800=X&flag_type-803=X&flag_type-936=X&form_name=enter_bug&groups=mozilla-employee-confidential&maketemplate=Remember%20values%20as%20bookmarkable%20template&op_sys=Unspecified&priority=--&product=mozilla.org&qa_contact=cknowles%40mozilla.com&rep_platform=Unspecified&short_desc=Request%20for%20a%20Private%20Repository%20in%20the%20ORGNAME%20GitHub%20organization&target_milestone=---&version=other here]. Be sure to answer all questions marked 'REQUIRED' in the form. As well as the ORGNAME in the title. This lets us know what the repo is for, who needs access, all so that we don't lose track of the private repo
<div id="github_transfer_bug"></div>
=== I want to transfer a repo ===
If this is a transfer into a Mozilla controlled org, and you're a member, you can transfer it yourself. This CAN mess up permissions to the repo, but filing a bug with the repo name and who should have access will let us help
If this is a transfer between Mozilla orgs, you'll need to file a bug with the details, and we're happy to do it.
If this is a transfer out of Mozilla controlled orgs, we'll need to get various approvals, but filing a bug will get this started.
For all of the above, the proper link here [https://bugzilla.mozilla.org/enter_bug.cgi?product=mozilla.org&component=Github%3A+Administration here]
=== Other requests ===
Note that if the org isn't controlled by MoCo IT, we may only be able to redirect you to whatever resources we're aware of per [[#other_github|this chart.]]
Things like "I need access to a Repo" - generally this is handled by repo admins, but if you need more, or help finding an admin, file a bug [https://bugzilla.mozilla.org/enter_bug.cgi?product=mozilla.org&component=Github%3A+Administration here] with questions
And general requests for help/advice - bugs to the [https://bugzilla.mozilla.org/enter_bug.cgi?product=mozilla.org&component=Github%3A+Administration GitHub Administration] component are the most reliable, but there's a matrix channel: [https://matrix.to/#/#github-admin:mozilla.org #github-admin], and email to ghe-admins @ mozilla . com
== Recommendations and FAQ ==
Each type has it's own installation and approval process. Please follow the instructions in the correct section below.
<div id="github_actions"></div>
==== GitHub Actions ====
[https://help.github.com/en/actions/getting-started-with-github-actions/about-github-actions GitHub Actions] allow automation to be initiated by various repository events. GitHub Actions are now available for all public repositories. Each organization makes a decision on whether or not they should be enabled. Check with your organization owners if you have questions.
To request a non-GitHub-authored action to be used in the "mozilla" organization, follow the procedure for requesting approval for a new GitHub App, immediately below.
<div id="github_apps"></div>
==== GitHub Apps Installation & Approval Process ====
However, the GitHub App installation can only be done by an organization owner, who may have to do additional housekeeping. This is not so good, so please plan accordingly (you may need to coordinate with [[#contact|GitHub owners]]).
* File a request using this [https://bugzilla.mozilla.org/enter_bug.cgi?comment=I%20want%20to%20use%20the%20NAME_HERE%20addon%20in%20ORG_NAME_HERE%20for%20the%20following%20reasons%3A%0D%0A%0D%0ABelow%20are%20my%20answers%20to%20your%20stock%20questions%3A%0D%0A%0D%0A%2A%2A%20Which%20repositories%20do%20you%20want%20to%20have%20access%3F%20%28all%20or%20list%29%0D%0A%0D%0A%2A%2A%20Are%20any%20of%20those%20repositories%20private%3F%0D%0A%0D%0A%2A%2A%20Provide%20link%20to%20vendor%27s%20description%20of%20permissions%20needed%20and%20why%0D%0A%0D%0A%2A%2A%20Provide%20the%20Install%20link%20for%20a%20GitHub%20app%0D%0A&component=Github%3A%20Administration&product=mozilla.org&short_desc=Assess%20use%20of%20external%20addon%20NAME_HERE%20in%20Mozilla%27s%20GitHub%20organization%20ORG_NAME_HERE bug [#github_actions_bug|template]]
* Include answers to the questions prompted for in the above template. Additional notes:
** ''Which repositories do you want to have access? (all or list)'' -- "All" will rarely be granted - every repository should have control over anything that can access their repository.
** "Team Member": team maintainers can add GitHub users to a team, if they are already a member of the organization. If they are not yet a member of the organization, the ''team maintainer'' should [https://bugzilla.mozilla.org/enter_bug.cgi?assigned_to=nobody%40mozilla.org&bug_ignored=0&bug_severity=normal&bug_status=NEW&bug_type=task&cf_fx_iteration=---&cf_fx_points=---&comment=I%27ve%20read%20https%3A%2F%2Fwiki.mozilla.org%2FGitHub%23Team_Maintainers_.26_Project_Leads%2C%20and%20need%20help%20adding%20a%20contributor%20to%20the%20org%3A%0D%0A%0D%0AName%3A%20%0D%0AMozilla%20Email%3A%20%0D%0AGithub%20Profile%20link%3A%20%2AStaff%20%2A%2AMUST%2A%2A%20have%20their%20verified%20GitHub%20identity%20listed%20in%20their%20people.m.o%20entry%2A%0D%0AGithub%20Team%28s%29%20%2AREQUIRED%2A%3A%20%0D%0A%0D%0AIf%20this%20is%20not%20being%20requested%20by%20a%20team%20maintainer%2C%20please%20request%20their%20approval%20via%20need-info.&component=Github%3A%20Administration&contenttypemethod=list&contenttypeselection=text%2Fplain&defined_groups=1&filed_via=standard_form&flag_type-4=X&flag_type-607=X&flag_type-800=X&flag_type-803=X&flag_type-936=X&form_name=enter_bug&maketemplate=Remember%20values%20as%20bookmarkable%20template&op_sys=Unspecified&priority=--&product=mozilla.org&rep_platform=Unspecified&target_milestone=---&version=other file a bug using this link] to add you to their team, as a form of vouching. "Team Member" is roughly analogous to "Level 2" or "Level 3", with the distinction being the content of the repositories managed by the team.
To get access for a new Contributor, please have the ''team maintainer'' or ''repository admin'' [https://bugzilla.mozilla.org/enter_bug.cgi?assigned_to=nobody%40mozilla.org&bug_ignored=0&bug_severity=normal&bug_status=NEW&bug_type=task&cf_fx_iteration=---&cf_fx_points=---&comment=I%27ve%20read%20https%3A%2F%2Fwiki.mozilla.org%2FGitHub%23Team_Maintainers_.26_Project_Leads%2C%20and%20need%20help%20adding%20a%20contributor%20to%20the%20org%3A%0D%0A%0D%0AName%3A%20%0D%0AMozilla%20Email%3A%20%0D%0AGithub%20Profile%20link%3A%20%2AStaff%20%2A%2AMUST%2A%2A%20have%20their%20verified%20GitHub%20identity%20listed%20in%20their%20people.m.o%20entry%2A%0D%0AGithub%20Team%28s%29%20%2AREQUIRED%2A%3A%20%0D%0A%0D%0AIf%20this%20is%20not%20being%20requested%20by%20a%20team%20maintainer%2C%20please%20request%20their%20approval%20via%20need-info.&component=Github%3A%20Administration&contenttypemethod=list&contenttypeselection=text%2Fplain&defined_groups=1&filed_via=standard_form&flag_type-4=X&flag_type-607=X&flag_type-800=X&flag_type-803=X&flag_type-936=X&form_name=enter_bug&maketemplate=Remember%20values%20as%20bookmarkable%20template&op_sys=Unspecified&priority=--&product=mozilla.org&qa_contact=cknowles%40mozilla.com&rep_platform=Unspecified&short_desc=Requesting%20GitHub%20membership%20to%20the%20%3CORGNAME%3E%20org%20for%20%3CUSERNAME%3E&target_milestone=---&version=other file a bug using the link in [[#github_member_bug|this link]] section, and fill in the details.
'''Please Note:'''
* If you need any paid services, contact GitHub owners for access to [https://github.com/mozilla/admin_for_mozilla_private/wiki/Billing-Notes Billing Notes]
<div id="forking"> </div>
=== Forking vs Transferring ===
'''Do not "fork" a repository into a Mozilla organization.''' Doing so gives ''every team in the org'' rights to it. There are a number of limitations to just pushing your repo's content into a new repo under mozilla (you loose all GitHub metadata). Refer to [https://docs.github.com/en/free-pro-team@latest/github/administering-a-repository/transferring-a-repository GitHub's docs] for details.
{{note|Remember that all repositories must comply with the [[GitHub/Repository Requirements]].|reminder}}
<div id="private"> </div>Being an open source company, Mozilla tries to do things in the open. However, the need for private repositories is clear for various non-public data and other business reasons, and in order to track them, please request private repositories using the template in [[#github_private_bug|this [https://bugzilla.mozilla.org/enter_bug.cgi?assigned_to=nobody%40mozilla.org&bug_ignored=0&bug_severity=--&bug_status=NEW&bug_type=task&cf_fx_iteration=---&cf_fx_points=---&comment=I%27ve%20read%20all%20of%20the%20%5Brepository%20creation%5D%5B1%5D%20section%2C%20and%20want%20to%20request%20a%20private%20repository.%20I%27ve%20filled%20in%20all%20the%20required%20fields.%0D%0A%0D%0AOrg%20for%20repo%3A%20REQUIRED%0D%0AName%20of%20Repository%3A%20%20REQUIRED%0D%0ALink%20to%20your%20people.m.o%20entry%20with%20verified%20GitHub%20login%3A%20REQUIRED%0D%0A%0D%0A%5BData%20Classification%5D%5B2%5D%20of%20data%20in%20repo%3A%20REQUIRED%0D%0AOther%20business%20justification%20for%20private%20repo%3A%0D%0AWhen%20can%20the%20repository%20be%20made%20public%3F%20REQUIRED%0D%0A%0D%0A%5B1%5D%3A%20https%3A%2F%2Fwiki.mozilla.org%2FGitHub%23Do_I_need_to_be_an_owner_to_create_repositories.3F%0D%0A%5B2%5D%3A%20https%3A%2F%2Fwiki.mozilla.org%2FSecurity%2FData_Classification%0D%0A&component=Github%3A%20Administration&contenttypemethod=list&contenttypeselection=text%2Fplain&defined_groups=1&filed_via=standard_form&flag_type-4=X&flag_type-607=X&flag_type-800=X&flag_type-803=X&flag_type-936=X&form_name=enter_bug&groups=mozilla-employee-confidential&maketemplate=Remember%20values%20as%20bookmarkable%20template&op_sys=Unspecified&priority=--&product=mozilla.org&qa_contact=cknowles%40mozilla.com&rep_platform=Unspecified&short_desc=Request%20for%20a%20Private%20Repository%20in%20the%20ORGNAME%20GitHub%20organization&target_milestone=---&version=other Bugzilla template]. Be sure to answer all questions marked 'REQUIRED' in the form. As well as the ORGNAME in the title] section.
As the creator, you will automatically have "admin" permissions on the repository. Repository Admins are responsible for the security settings of the repository. This includes approving (or not) requests for GitHub Apps to be added to the app.
