jprdonnelly/docs
1
0
Fork 0
mirror of synced 2026-02-03 00:02:00 -05:00
Code Issues Projects Releases Wiki Activity

Merge pull request #24086 from github/repo-sync

Browse Source 
repo sync
This commit is contained in:
Octomerger Bot
2023-02-22 09:01:52 -08:00
committed by GitHub
parent 11da7489d8 8268f5d0ce
commit dedd5ff790
13 changed files with 999 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
content/admin/index.md
View File

@@ -72,13 +72,11 @@ featuredLinks:
startHere:
- '{% ifversion ghae %}/admin/user-management/managing-users-in-your-enterprise/auditing-users-across-your-enterprise{% endif %}'
- /admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise
- /admin/policies/enforcing-policies-for-your-enterprise/about-enterprise-policies
- '{% ifversion ghae %}/admin/configuration/restricting-network-traffic-to-your-enterprise-with-an-ip-allow-list{% endif %}'
- '{% ifversion ghes %}/admin/configuration/configuring-your-enterprise/configuring-backups-on-your-appliance{% endif %}'
- '{% ifversion ghes %}/admin/enterprise-management/configuring-high-availability/creating-a-high-availability-replica{% endif %}'
- '{% ifversion ghes %}/admin/overview/about-upgrades-to-new-releases{% endif %}'
- '{% ifversion ghec %}/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise{% endif %}'
- '{% ifversion ghec %}/admin/user-management/managing-organizations-in-your-enterprise/adding-organizations-to-your-enterprise{% endif %}'
- '/admin/user-management/managing-organizations-in-your-enterprise/best-practices-for-structuring-organizations-in-your-enterprise'
- '{% ifversion ghes %}/admin/overview/about-upgrades-to-new-releases{% endif %}'
- '{% ifversion ghae %}/admin/policies/enforcing-policies-for-your-enterprise/about-enterprise-policies{% endif %}'
guideCards:
- '{% ifversion ghes %}/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server{% endif %}'
- '{% ifversion ghes %}/admin/packages/getting-started-with-github-packages-for-your-enterprise{% endif %}'
@@ -89,6 +87,7 @@ featuredLinks:
- '{% ifversion ghec %}/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise{% endif %}'
- '{% ifversion ghec %}/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-code-security-and-analysis-for-your-enterprise{% endif %}'
- '{% ifversion ghec %}/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise{% endif %}'
- '/admin/user-management/managing-organizations-in-your-enterprise/best-practices-for-structuring-organizations-in-your-enterprise'
popular:
- /admin/overview/about-github-enterprise-server
- '{% ifversion ghae %}/admin/release-notes{% endif %}'
@@ -126,4 +125,3 @@ children:
- /release-notes
- /all-releases
---

8
content/admin/overview/best-practices-for-enterprises.md
View File

@@ -18,20 +18,20 @@ topics:
{% data reusables.enterprise.ghec-authentication-options %}
For help identifying the authentication method that will best meet your needs, see "[AUTOTITLE](/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise)."
For help identifying the authentication method that will best meet your needs, see "[AUTOTITLE](/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise)."
{% endif %}
## Use policies
We recommend using policies to enforce business rules and regulatory compliance.
We recommend using policies to enforce business rules and regulatory compliance.
{% data reusables.enterprise.about-policies %} For more information, see "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/about-enterprise-policies)."
## Minimize the number of organizations
Large enterprises often need multiple organizations, but try to create as few as possible to reflect top-level corporate divisions. A smaller number of organizations encourages innersource practices and allows discussions to involve a wider audience.
Most businesses are best served by a single organization. Some enterprises may need multiple organizations for compliance or security reasons, but try to create as few as possible. A smaller number of organizations encourages innersource practice, allows discussions to involve a wider audience, and reduces administrative overhead.
Instead, you can manage repository access and security requirements at a more granular level within each organization by using teams. For more information, see "[AUTOTITLE](/organizations/organizing-members-into-teams/about-teams)."
For more guidance on how many organizations to create and how to structure them, see "[AUTOTITLE](/admin/user-management/managing-organizations-in-your-enterprise/best-practices-for-structuring-organizations-in-your-enterprise)."
## Avoid extensive collaboration in user-owned repositories

90
content/admin/user-management/managing-organizations-in-your-enterprise/best-practices-for-structuring-organizations-in-your-enterprise.md Normal file
View File

@@ -0,0 +1,90 @@
---
title: Best practices for structuring organizations in your enterprise
intro: 'Learn to identify how many organizations to create within your enterprise, and how you should structure them.'
versions:
ghec: '*'
ghes: '*'
ghae: '*'
type: overview
topics:
- Administrator
- Enterprise
- Organizations
shortTitle: Best practices
---
## About best practices for organizations within an enterprise
There are a multiple options for structuring the organizations within your enterprise. Each approach has pros and cons, and the best structure for your enterprise depends on the characteristics and needs of your business, including size and security constraints.
However, we also recommend aligning your strategy with the culture you want to create, not the culture you currently have. If you want to advance in terms of collaboration and innersourcing, structure your tools accordingly. Then, your tools can assist you in the cultural change instead of acting as a blocker.
## About organizational number
In general, {% data variables.product.company_short %} recommends minimizing the number of organizations you create. Having fewer organizations encourages greater collaboration and innersourcing, which increases efficiency. In fact, many businesses are best served by a single organization, for the following reasons.
- It's easier to find resources within a single organization, as there's only one place to search.
- It's easier to communicate within a single organization, as @-mentions only work between members of the same organization.
- Being part of a single, large organization where anyone and anything is accessible fosters collaboration and loyalty, whereas being separated into smaller organizations can make teams more isolated.
Organization owners always have access to all repositories owned by the organization. If your company is large enough that no single owner should have access to all repositories, consider creating multiple organizations.
The main benefit of creating multiple organizations is the ability to configure separate policies, settings, and requirements for each. For example, each organization can have a different SAML configuration.
Avoid creating a one-to-one relationship between organizations and structural entities of your company, such as individual teams or business units. Instead, group structural entities that can share policies, settings, and requirements into a single organization. This approach maximizes collaboration while meeting your regulatory requirements.
It’s always easier to add organizations than to remove them, so we recommend starting with a small number of organizations, which gives you more flexibility in the future. After you develop more experience of what works well for your business, you can create additional organizations if the need arises.
Removing organizations is much more difficult, often requiring migrations and a reduction in flexibility that teams have gotten used to. Many customers have come to regret creating a large number of organizations after they experience the challenging and time-consuming process of reducing their number.
We recommend creating and enforcing fixed and transparent rules for creating a new organization in your enterprise. This will make it easier for everyone to understand the purpose of each organization and which assets are located where.
## About organizational structure
There are five main archetypes for organizational structure. The archetypes are defined by two decisions:
- Whether to use a single organization or multiple organizations
- Whether to grant all members access to all repositories, or use teams to manage repository access more granularly
For more information about teams, see "[About teams](/organizations/organizing-members-into-teams/about-teams)."
### Single organization with direct repository access
The simplest organizational structure is a single organization, where members are granted access to all repositories directly via organization membership. Teams may be used for coordination and communication, but not for managing repository access.
This structure works best for small companies, such as startups, where everyone collaborates on everything. It can work for medium-sized companies as well, if trust is high.
To use this archetype, set the base permissions for the organization to "Write" or "Read." For more information, see "[Setting base permissions for an organization](/organizations/managing-user-access-to-your-organizations-repositories/setting-base-permissions-for-an-organization)."
### Single organization with teams for repository access
If your company needs to control repository access more granularly, you can set the base permissions for your organization to "None," then give each team access to specific repositories only.
This structure works best for medium-sized companies, or for small companies with lower trust. For smaller companies with high trust, where everyone collaborates on everything, administering teams may not be worth the time investment.
### Multiple organizations with direct repository access
For larger companies, managing repository access within a single organization can become unwieldy, even with teams. This archetype utilizes multiple organizations to manage repository access instead. Each organization's members have access to all of that organization's repositories.
This structure works best for companies that are large enough to have different groups that don't need to work together. This structure is not as useful if collaboration across business units is important.
To use this archetype, create one organization for each group that can share policies, settings, and requirements as described above, then set the base permissions for each organization to "Write" or "Read."
### Multiple organizations with teams for repository access
Very large companies may require more granular control over repository access, even within multiple organizations. In this case, you can use teams to give each group access to specific repositories only.
To use this archetype, create one organization for each group that can share policies, settings, and requirements as described above, set the base permission for each organization to "None," then give each team access to specific repositories only.
### Multiple organizations with different access methods
If you want the collaboration benefits of a single organization with direct repository access, but you have a small number of repositories that are too sensitive for global access, consider using multiple organizations with a mix of access methods.
To use this archetype, create one organization for all of your employees and most of your repositories. Grant all members access to all repositories in this organization by setting the base permissions for the organization to "Write" or "Read."
Then, create a second organization specifically for more sensitive repositories. In this organization, set the base permissions to "None", add only the people that need to access the sensitive repositories, and manage access to the repositories via team membership.
## Further reading
- [Organize your experts with ad hoc teams](https://github.blog/2017-02-15-organize-your-experts-with-ad-hoc-teams/) in the {% data variables.product.company_short %} blog
- "[Best practices for organizations](/organizations/collaborating-with-groups-in-organizations/best-practices-for-organizations)"

2
content/admin/user-management/managing-organizations-in-your-enterprise/index.md
View File

@@ -20,6 +20,7 @@ versions:
topics:
- Enterprise
children:
- /best-practices-for-structuring-organizations-in-your-enterprise
- /adding-organizations-to-your-enterprise
- /configuring-visibility-for-organization-membership
- /preventing-users-from-creating-organizations
@@ -34,4 +35,3 @@ children:
- /continuous-integration-using-jenkins
shortTitle: Manage organizations
---

2
content/get-started/privacy-on-github/opting-into-or-out-of-the-github-archive-program-for-your-public-repository.md
View File

@@ -15,7 +15,7 @@ shortTitle: GitHub Archive program
{% data reusables.repositories.about-github-archive-program %} For more information, see "[AUTOTITLE](/repositories/archiving-a-github-repository/about-archiving-content-and-data-on-github#about-the-github-archive-program)."
If you opt out of the {% data variables.product.prodname_archive %} for a repository, the repository will be excluded from any long-term archives that {% data variables.product.prodname_dotcom %} may create in the future. We will also send a request to each of our partner organizations to remove the repository from their data.
If you opt out of the {% data variables.product.prodname_archive %} for a repository, the repository will be excluded from any long-term archives that {% data variables.product.prodname_dotcom %} may create in the future.
{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.sidebar-settings %}

189
data/graphql/ghec/schema.docs.graphql
View File

@@ -7032,6 +7032,51 @@ type CreateProjectPayload {
project: Project
}
"""
Autogenerated input type of CreateProjectV2Field
"""
input CreateProjectV2FieldInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The data type of the field.
"""
dataType: ProjectV2CustomFieldType!
"""
The name of the field.
"""
name: String!
"""
The ID of the Project to create the field in.
"""
projectId: ID! @possibleTypes(concreteTypes: ["ProjectV2"])
"""
Options for a single select field. At least one value is required if data_type is SINGLE_SELECT
"""
singleSelectOptions: [ProjectV2SingleSelectFieldOptionInput!]
}
"""
Autogenerated return type of CreateProjectV2Field
"""
type CreateProjectV2FieldPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The new field.
"""
projectV2Field: ProjectV2FieldConfiguration
}
"""
Autogenerated input type of CreateProjectV2
"""
@@ -8528,6 +8573,40 @@ type DeleteProjectPayload {
owner: ProjectOwner
}
"""
Autogenerated input type of DeleteProjectV2Field
"""
input DeleteProjectV2FieldInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The ID of the field to delete.
"""
fieldId: ID!
@possibleTypes(
concreteTypes: ["ProjectV2Field", "ProjectV2IterationField", "ProjectV2SingleSelectField"]
abstractType: "ProjectV2FieldConfiguration"
)
}
"""
Autogenerated return type of DeleteProjectV2Field
"""
type DeleteProjectV2FieldPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The deleted field.
"""
projectV2Field: ProjectV2FieldConfiguration
}
"""
Autogenerated input type of DeleteProjectV2
"""
@@ -20537,6 +20616,16 @@ type Mutation {
input: CreateProjectV2Input!
): CreateProjectV2Payload
"""
Create a new project field.
"""
createProjectV2Field(
"""
Parameters for CreateProjectV2Field
"""
input: CreateProjectV2FieldInput!
): CreateProjectV2FieldPayload
"""
Create a new pull request
"""
@@ -20777,6 +20866,16 @@ type Mutation {
input: DeleteProjectV2Input!
): DeleteProjectV2Payload
"""
Delete a project field.
"""
deleteProjectV2Field(
"""
Parameters for DeleteProjectV2Field
"""
input: DeleteProjectV2FieldInput!
): DeleteProjectV2FieldPayload
"""
Deletes an item from a Project.
"""
@@ -29887,6 +29986,31 @@ type ProjectV2Connection {
totalCount: Int!
}
"""
The type of a project field.
"""
enum ProjectV2CustomFieldType {
"""
Date
"""
DATE
"""
Number
"""
NUMBER
"""
Single Select
"""
SINGLE_SELECT
"""
Text
"""
TEXT
}
"""
An edge in a connection.
"""
@@ -31196,6 +31320,71 @@ type ProjectV2SingleSelectFieldOption {
nameHTML: String!
}
"""
The display color of a single-select field option.
"""
enum ProjectV2SingleSelectFieldOptionColor {
"""
BLUE
"""
BLUE
"""
GRAY
"""
GRAY
"""
GREEN
"""
GREEN
"""
ORANGE
"""
ORANGE
"""
PINK
"""
PINK
"""
PURPLE
"""
PURPLE
"""
RED
"""
RED
"""
YELLOW
"""
YELLOW
}
"""
Represents a single select field option
"""
input ProjectV2SingleSelectFieldOptionInput {
"""
The display color of the option
"""
color: ProjectV2SingleSelectFieldOptionColor!
"""
The description text of the option
"""
description: String!
"""
The name of the option
"""
name: String!
}
"""
Represents a sort by field and direction.
"""

189
data/graphql/schema.docs.graphql
View File

@@ -7032,6 +7032,51 @@ type CreateProjectPayload {
project: Project
}
"""
Autogenerated input type of CreateProjectV2Field
"""
input CreateProjectV2FieldInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The data type of the field.
"""
dataType: ProjectV2CustomFieldType!
"""
The name of the field.
"""
name: String!
"""
The ID of the Project to create the field in.
"""
projectId: ID! @possibleTypes(concreteTypes: ["ProjectV2"])
"""
Options for a single select field. At least one value is required if data_type is SINGLE_SELECT
"""
singleSelectOptions: [ProjectV2SingleSelectFieldOptionInput!]
}
"""
Autogenerated return type of CreateProjectV2Field
"""
type CreateProjectV2FieldPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The new field.
"""
projectV2Field: ProjectV2FieldConfiguration
}
"""
Autogenerated input type of CreateProjectV2
"""
@@ -8528,6 +8573,40 @@ type DeleteProjectPayload {
owner: ProjectOwner
}
"""
Autogenerated input type of DeleteProjectV2Field
"""
input DeleteProjectV2FieldInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The ID of the field to delete.
"""
fieldId: ID!
@possibleTypes(
concreteTypes: ["ProjectV2Field", "ProjectV2IterationField", "ProjectV2SingleSelectField"]
abstractType: "ProjectV2FieldConfiguration"
)
}
"""
Autogenerated return type of DeleteProjectV2Field
"""
type DeleteProjectV2FieldPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
The deleted field.
"""
projectV2Field: ProjectV2FieldConfiguration
}
"""
Autogenerated input type of DeleteProjectV2
"""
@@ -20537,6 +20616,16 @@ type Mutation {
input: CreateProjectV2Input!
): CreateProjectV2Payload
"""
Create a new project field.
"""
createProjectV2Field(
"""
Parameters for CreateProjectV2Field
"""
input: CreateProjectV2FieldInput!
): CreateProjectV2FieldPayload
"""
Create a new pull request
"""
@@ -20777,6 +20866,16 @@ type Mutation {
input: DeleteProjectV2Input!
): DeleteProjectV2Payload
"""
Delete a project field.
"""
deleteProjectV2Field(
"""
Parameters for DeleteProjectV2Field
"""
input: DeleteProjectV2FieldInput!
): DeleteProjectV2FieldPayload
"""
Deletes an item from a Project.
"""
@@ -29887,6 +29986,31 @@ type ProjectV2Connection {
totalCount: Int!
}
"""
The type of a project field.
"""
enum ProjectV2CustomFieldType {
"""
Date
"""
DATE
"""
Number
"""
NUMBER
"""
Single Select
"""
SINGLE_SELECT
"""
Text
"""
TEXT
}
"""
An edge in a connection.
"""
@@ -31196,6 +31320,71 @@ type ProjectV2SingleSelectFieldOption {
nameHTML: String!
}
"""
The display color of a single-select field option.
"""
enum ProjectV2SingleSelectFieldOptionColor {
"""
BLUE
"""
BLUE
"""
GRAY
"""
GRAY
"""
GREEN
"""
GREEN
"""
ORANGE
"""
ORANGE
"""
PINK
"""
PINK
"""
PURPLE
"""
PURPLE
"""
RED
"""
RED
"""
YELLOW
"""
YELLOW
}
"""
Represents a single select field option
"""
input ProjectV2SingleSelectFieldOptionInput {
"""
The display color of the option
"""
color: ProjectV2SingleSelectFieldOptionColor!
"""
The description text of the option
"""
description: String!
"""
The name of the option
"""
name: String!
}
"""
Represents a sort by field and direction.
"""

2
data/reusables/actions/jobs/section-using-jobs-in-a-workflow-needs.md
View File

@@ -1,4 +1,4 @@
Use `jobs.<job_id>.needs` to identify any jobs that must complete successfully before this job will run. It can be a string or array of strings. If a job fails, all jobs that need it are skipped unless the jobs use a conditional expression that causes the job to continue. If a run contains a series of jobs that need each other, a failure applies to all jobs in the dependency chain from the point of failure onwards.
Use `jobs.<job_id>.needs` to identify any jobs that must complete successfully before this job will run. It can be a string or array of strings. If a job fails or is skipped, all jobs that need it are skipped unless the jobs use a conditional expression that causes the job to continue. If a run contains a series of jobs that need each other, a failure or skip applies to all jobs in the dependency chain from the point of failure or skip onwards.
### Example: Requiring successful dependent jobs

11
lib/page-data.js
View File

@@ -147,6 +147,17 @@ async function translateTree(dir, langObj, enTree) {
return [key, data[key]]
})
)
// A lot of translations have corruptions around the AUTOTITLE links.
// We've requested that these are corrected back but as a temporary
// solution we'll manually recover now.
// See internal issue #2762
// In late 2023, search in the translations repos if these things are
// still happening and if not, the following lines can be removed.
content = content.replaceAll('[AUTOTITLE"을 참조하세요]', '[AUTOTITLE]')
content = content.replaceAll('[AUTOTITLE"을]', '[AUTOTITLE]')
content = content.replaceAll('["AUTOTITLE]', '"[AUTOTITLE]')
// The "content" isn't a frontmatter key
translatedData.markdown = content

4
lib/render-content/plugins/rewrite-local-links.js
View File

@@ -144,9 +144,9 @@ function getNewHref(node, languageCode, version) {
version = nonEnterpriseDefaultVersion
}
// admin links on dotcom always point to Enterprise
// admin links on dotcom always point to Enterprise Cloud
if (patterns.adminProduct.test(hrefWithoutLang) && version === nonEnterpriseDefaultVersion) {
version = `enterprise-server@${latest}`
version = 'enterprise-cloud@latest'
}
// ------ END ONE-OFF OVERRIDES ------//

21
src/graphql/data/dotcom/changelog.json
View File

@@ -1,4 +1,25 @@
[
{
"schemaChanges": [
{
"title": "The GraphQL schema includes these changes:",
"changes": [
"<p>Type 'CreateProjectV2FieldInput' was added</p>",
"<p>Type 'CreateProjectV2FieldPayload' was added</p>",
"<p>Type 'DeleteProjectV2FieldInput' was added</p>",
"<p>Type 'DeleteProjectV2FieldPayload' was added</p>",
"<p>Type 'ProjectV2CustomFieldType' was added</p>",
"<p>Type 'ProjectV2SingleSelectFieldOptionColor' was added</p>",
"<p>Type 'ProjectV2SingleSelectFieldOptionInput' was added</p>",
"<p>Field 'createProjectV2Field<code>was added to object type</code>Mutation'</p>",
"<p>Field 'deleteProjectV2Field<code>was added to object type</code>Mutation'</p>"
]
}
],
"previewChanges": [],
"upcomingChanges": [],
"date": "2023-02-22"
},
{
"schemaChanges": [
{

243
src/graphql/data/dotcom/schema.json
View File

@@ -2870,6 +2870,40 @@
}
]
},
{
"name": "createProjectV2Field",
"kind": "mutations",
"id": "createprojectv2field",
"href": "/graphql/reference/mutations#createprojectv2field",
"description": "<p>Create a new project field.</p>",
"inputFields": [
{
"name": "input",
"type": "CreateProjectV2FieldInput!",
"id": "createprojectv2fieldinput",
"kind": "input-objects",
"href": "/graphql/reference/input-objects#createprojectv2fieldinput"
}
],
"returnFields": [
{
"name": "clientMutationId",
"type": "String",
"id": "string",
"kind": "scalars",
"href": "/graphql/reference/scalars#string",
"description": "<p>A unique identifier for the client performing the mutation.</p>"
},
{
"name": "projectV2Field",
"type": "ProjectV2FieldConfiguration",
"id": "projectv2fieldconfiguration",
"kind": "unions",
"href": "/graphql/reference/unions#projectv2fieldconfiguration",
"description": "<p>The new field.</p>"
}
]
},
{
"name": "createPullRequest",
"kind": "mutations",
@@ -3692,6 +3726,40 @@
}
]
},
{
"name": "deleteProjectV2Field",
"kind": "mutations",
"id": "deleteprojectv2field",
"href": "/graphql/reference/mutations#deleteprojectv2field",
"description": "<p>Delete a project field.</p>",
"inputFields": [
{
"name": "input",
"type": "DeleteProjectV2FieldInput!",
"id": "deleteprojectv2fieldinput",
"kind": "input-objects",
"href": "/graphql/reference/input-objects#deleteprojectv2fieldinput"
}
],
"returnFields": [
{
"name": "clientMutationId",
"type": "String",
"id": "string",
"kind": "scalars",
"href": "/graphql/reference/scalars#string",
"description": "<p>A unique identifier for the client performing the mutation.</p>"
},
{
"name": "projectV2Field",
"type": "ProjectV2FieldConfiguration",
"id": "projectv2fieldconfiguration",
"kind": "unions",
"href": "/graphql/reference/unions#projectv2fieldconfiguration",
"description": "<p>The deleted field.</p>"
}
]
},
{
"name": "deleteProjectV2Item",
"kind": "mutations",
@@ -77219,6 +77287,31 @@
}
]
},
{
"name": "ProjectV2CustomFieldType",
"kind": "enums",
"id": "projectv2customfieldtype",
"href": "/graphql/reference/enums#projectv2customfieldtype",
"description": "<p>The type of a project field.</p>",
"values": [
{
"name": "DATE",
"description": "<p>Date.</p>"
},
{
"name": "NUMBER",
"description": "<p>Number.</p>"
},
{
"name": "SINGLE_SELECT",
"description": "<p>Single Select.</p>"
},
{
"name": "TEXT",
"description": "<p>Text.</p>"
}
]
},
{
"name": "ProjectV2FieldOrderField",
"kind": "enums",
@@ -77381,6 +77474,47 @@
}
]
},
{
"name": "ProjectV2SingleSelectFieldOptionColor",
"kind": "enums",
"id": "projectv2singleselectfieldoptioncolor",
"href": "/graphql/reference/enums#projectv2singleselectfieldoptioncolor",
"description": "<p>The display color of a single-select field option.</p>",
"values": [
{
"name": "BLUE",
"description": "<p>BLUE.</p>"
},
{
"name": "GRAY",
"description": "<p>GRAY.</p>"
},
{
"name": "GREEN",
"description": "<p>GREEN.</p>"
},
{
"name": "ORANGE",
"description": "<p>ORANGE.</p>"
},
{
"name": "PINK",
"description": "<p>PINK.</p>"
},
{
"name": "PURPLE",
"description": "<p>PURPLE.</p>"
},
{
"name": "RED",
"description": "<p>RED.</p>"
},
{
"name": "YELLOW",
"description": "<p>YELLOW.</p>"
}
]
},
{
"name": "ProjectV2State",
"kind": "enums",
@@ -85306,6 +85440,56 @@
}
]
},
{
"name": "CreateProjectV2FieldInput",
"kind": "inputObjects",
"id": "createprojectv2fieldinput",
"href": "/graphql/reference/input-objects#createprojectv2fieldinput",
"description": "<p>Autogenerated input type of CreateProjectV2Field.</p>",
"inputFields": [
{
"name": "clientMutationId",
"description": "<p>A unique identifier for the client performing the mutation.</p>",
"type": "String",
"id": "string",
"kind": "scalars",
"href": "/graphql/reference/scalars#string"
},
{
"name": "dataType",
"description": "<p>The data type of the field.</p>",
"type": "ProjectV2CustomFieldType!",
"id": "projectv2customfieldtype",
"kind": "enums",
"href": "/graphql/reference/enums#projectv2customfieldtype"
},
{
"name": "name",
"description": "<p>The name of the field.</p>",
"type": "String!",
"id": "string",
"kind": "scalars",
"href": "/graphql/reference/scalars#string"
},
{
"name": "projectId",
"description": "<p>The ID of the Project to create the field in.</p>",
"type": "ID!",
"id": "id",
"kind": "scalars",
"href": "/graphql/reference/scalars#id",
"isDeprecated": false
},
{
"name": "singleSelectOptions",
"description": "<p>Options for a single select field. At least one value is required if data_type is SINGLE_SELECT.</p>",
"type": "[ProjectV2SingleSelectFieldOptionInput!]",
"id": "projectv2singleselectfieldoptioninput",
"kind": "input-objects",
"href": "/graphql/reference/input-objects#projectv2singleselectfieldoptioninput"
}
]
},
{
"name": "CreateProjectV2Input",
"kind": "inputObjects",
@@ -86344,6 +86528,32 @@
}
]
},
{
"name": "DeleteProjectV2FieldInput",
"kind": "inputObjects",
"id": "deleteprojectv2fieldinput",
"href": "/graphql/reference/input-objects#deleteprojectv2fieldinput",
"description": "<p>Autogenerated input type of DeleteProjectV2Field.</p>",
"inputFields": [
{
"name": "clientMutationId",
"description": "<p>A unique identifier for the client performing the mutation.</p>",
"type": "String",
"id": "string",
"kind": "scalars",
"href": "/graphql/reference/scalars#string"
},
{
"name": "fieldId",
"description": "<p>The ID of the field to delete.</p>",
"type": "ID!",
"id": "id",
"kind": "scalars",
"href": "/graphql/reference/scalars#id",
"isDeprecated": false
}
]
},
{
"name": "DeleteProjectV2Input",
"kind": "inputObjects",
@@ -88473,6 +88683,39 @@
}
]
},
{
"name": "ProjectV2SingleSelectFieldOptionInput",
"kind": "inputObjects",
"id": "projectv2singleselectfieldoptioninput",
"href": "/graphql/reference/input-objects#projectv2singleselectfieldoptioninput",
"description": "<p>Represents a single select field option.</p>",
"inputFields": [
{
"name": "color",
"description": "<p>The display color of the option.</p>",
"type": "ProjectV2SingleSelectFieldOptionColor!",
"id": "projectv2singleselectfieldoptioncolor",
"kind": "enums",
"href": "/graphql/reference/enums#projectv2singleselectfieldoptioncolor"
},
{
"name": "description",
"description": "<p>The description text of the option.</p>",
"type": "String!",
"id": "string",
"kind": "scalars",
"href": "/graphql/reference/scalars#string"
},
{
"name": "name",
"description": "<p>The name of the option.</p>",
"type": "String!",
"id": "string",
"kind": "scalars",
"href": "/graphql/reference/scalars#string"
}
]
},
{
"name": "ProjectV2ViewOrder",
"kind": "inputObjects",

243
src/graphql/data/ghec/schema.json
View File

@@ -2870,6 +2870,40 @@
}
]
},
{
"name": "createProjectV2Field",
"kind": "mutations",
"id": "createprojectv2field",
"href": "/graphql/reference/mutations#createprojectv2field",
"description": "<p>Create a new project field.</p>",
"inputFields": [
{
"name": "input",
"type": "CreateProjectV2FieldInput!",
"id": "createprojectv2fieldinput",
"kind": "input-objects",
"href": "/graphql/reference/input-objects#createprojectv2fieldinput"
}
],
"returnFields": [
{
"name": "clientMutationId",
"type": "String",
"id": "string",
"kind": "scalars",
"href": "/graphql/reference/scalars#string",
"description": "<p>A unique identifier for the client performing the mutation.</p>"
},
{
"name": "projectV2Field",
"type": "ProjectV2FieldConfiguration",
"id": "projectv2fieldconfiguration",
"kind": "unions",
"href": "/graphql/reference/unions#projectv2fieldconfiguration",
"description": "<p>The new field.</p>"
}
]
},
{
"name": "createPullRequest",
"kind": "mutations",
@@ -3692,6 +3726,40 @@
}
]
},
{
"name": "deleteProjectV2Field",
"kind": "mutations",
"id": "deleteprojectv2field",
"href": "/graphql/reference/mutations#deleteprojectv2field",
"description": "<p>Delete a project field.</p>",
"inputFields": [
{
"name": "input",
"type": "DeleteProjectV2FieldInput!",
"id": "deleteprojectv2fieldinput",
"kind": "input-objects",
"href": "/graphql/reference/input-objects#deleteprojectv2fieldinput"
}
],
"returnFields": [
{
"name": "clientMutationId",
"type": "String",
"id": "string",
"kind": "scalars",
"href": "/graphql/reference/scalars#string",
"description": "<p>A unique identifier for the client performing the mutation.</p>"
},
{
"name": "projectV2Field",
"type": "ProjectV2FieldConfiguration",
"id": "projectv2fieldconfiguration",
"kind": "unions",
"href": "/graphql/reference/unions#projectv2fieldconfiguration",
"description": "<p>The deleted field.</p>"
}
]
},
{
"name": "deleteProjectV2Item",
"kind": "mutations",
@@ -77219,6 +77287,31 @@
}
]
},
{
"name": "ProjectV2CustomFieldType",
"kind": "enums",
"id": "projectv2customfieldtype",
"href": "/graphql/reference/enums#projectv2customfieldtype",
"description": "<p>The type of a project field.</p>",
"values": [
{
"name": "DATE",
"description": "<p>Date.</p>"
},
{
"name": "NUMBER",
"description": "<p>Number.</p>"
},
{
"name": "SINGLE_SELECT",
"description": "<p>Single Select.</p>"
},
{
"name": "TEXT",
"description": "<p>Text.</p>"
}
]
},
{
"name": "ProjectV2FieldOrderField",
"kind": "enums",
@@ -77381,6 +77474,47 @@
}
]
},
{
"name": "ProjectV2SingleSelectFieldOptionColor",
"kind": "enums",
"id": "projectv2singleselectfieldoptioncolor",
"href": "/graphql/reference/enums#projectv2singleselectfieldoptioncolor",
"description": "<p>The display color of a single-select field option.</p>",
"values": [
{
"name": "BLUE",
"description": "<p>BLUE.</p>"
},
{
"name": "GRAY",
"description": "<p>GRAY.</p>"
},
{
"name": "GREEN",
"description": "<p>GREEN.</p>"
},
{
"name": "ORANGE",
"description": "<p>ORANGE.</p>"
},
{
"name": "PINK",
"description": "<p>PINK.</p>"
},
{
"name": "PURPLE",
"description": "<p>PURPLE.</p>"
},
{
"name": "RED",
"description": "<p>RED.</p>"
},
{
"name": "YELLOW",
"description": "<p>YELLOW.</p>"
}
]
},
{
"name": "ProjectV2State",
"kind": "enums",
@@ -85306,6 +85440,56 @@
}
]
},
{
"name": "CreateProjectV2FieldInput",
"kind": "inputObjects",
"id": "createprojectv2fieldinput",
"href": "/graphql/reference/input-objects#createprojectv2fieldinput",
"description": "<p>Autogenerated input type of CreateProjectV2Field.</p>",
"inputFields": [
{
"name": "clientMutationId",
"description": "<p>A unique identifier for the client performing the mutation.</p>",
"type": "String",
"id": "string",
"kind": "scalars",
"href": "/graphql/reference/scalars#string"
},
{
"name": "dataType",
"description": "<p>The data type of the field.</p>",
"type": "ProjectV2CustomFieldType!",
"id": "projectv2customfieldtype",
"kind": "enums",
"href": "/graphql/reference/enums#projectv2customfieldtype"
},
{
"name": "name",
"description": "<p>The name of the field.</p>",
"type": "String!",
"id": "string",
"kind": "scalars",
"href": "/graphql/reference/scalars#string"
},
{
"name": "projectId",
"description": "<p>The ID of the Project to create the field in.</p>",
"type": "ID!",
"id": "id",
"kind": "scalars",
"href": "/graphql/reference/scalars#id",
"isDeprecated": false
},
{
"name": "singleSelectOptions",
"description": "<p>Options for a single select field. At least one value is required if data_type is SINGLE_SELECT.</p>",
"type": "[ProjectV2SingleSelectFieldOptionInput!]",
"id": "projectv2singleselectfieldoptioninput",
"kind": "input-objects",
"href": "/graphql/reference/input-objects#projectv2singleselectfieldoptioninput"
}
]
},
{
"name": "CreateProjectV2Input",
"kind": "inputObjects",
@@ -86344,6 +86528,32 @@
}
]
},
{
"name": "DeleteProjectV2FieldInput",
"kind": "inputObjects",
"id": "deleteprojectv2fieldinput",
"href": "/graphql/reference/input-objects#deleteprojectv2fieldinput",
"description": "<p>Autogenerated input type of DeleteProjectV2Field.</p>",
"inputFields": [
{
"name": "clientMutationId",
"description": "<p>A unique identifier for the client performing the mutation.</p>",
"type": "String",
"id": "string",
"kind": "scalars",
"href": "/graphql/reference/scalars#string"
},
{
"name": "fieldId",
"description": "<p>The ID of the field to delete.</p>",
"type": "ID!",
"id": "id",
"kind": "scalars",
"href": "/graphql/reference/scalars#id",
"isDeprecated": false
}
]
},
{
"name": "DeleteProjectV2Input",
"kind": "inputObjects",
@@ -88473,6 +88683,39 @@
}
]
},
{
"name": "ProjectV2SingleSelectFieldOptionInput",
"kind": "inputObjects",
"id": "projectv2singleselectfieldoptioninput",
"href": "/graphql/reference/input-objects#projectv2singleselectfieldoptioninput",
"description": "<p>Represents a single select field option.</p>",
"inputFields": [
{
"name": "color",
"description": "<p>The display color of the option.</p>",
"type": "ProjectV2SingleSelectFieldOptionColor!",
"id": "projectv2singleselectfieldoptioncolor",
"kind": "enums",
"href": "/graphql/reference/enums#projectv2singleselectfieldoptioncolor"
},
{
"name": "description",
"description": "<p>The description text of the option.</p>",
"type": "String!",
"id": "string",
"kind": "scalars",
"href": "/graphql/reference/scalars#string"
},
{
"name": "name",
"description": "<p>The name of the option.</p>",
"type": "String!",
"id": "string",
"kind": "scalars",
"href": "/graphql/reference/scalars#string"
}
]
},
{
"name": "ProjectV2ViewOrder",
"kind": "inputObjects",