You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/issues/planning-and-tracking-with-projects/understanding-fields/about-issue-fields.md
+3-2Lines changed: 3 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,8 +13,9 @@ category:
13
13
14
14
Issue fields are organization-level fields that provide consistent, typed metadata across all repositories. Unlike project custom fields, issue fields are defined once at the organization level and are available on every issue and in every project across the organization. For more information on creating and managing issue fields, see [AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-in-your-organization).
15
15
16
-
> [!NOTE]
17
-
> Issue fields are currently only supported in private projects. Issue fields are not available in public projects.
16
+
## Issue fields in public and internal projects
17
+
18
+
Only fields with **Public** visibility appear in public and internal projects. Organization-only fields are hidden. For details on configuring field visibility and how visibility changes affect projects, see [AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-in-your-organization#setting-field-visibility).
Copy file name to clipboardExpand all lines: content/issues/tracking-your-work-with-issues/using-issues/adding-and-managing-issue-fields.md
+23Lines changed: 23 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,6 +14,9 @@ category:
14
14
15
15
Issue fields appear in the right-hand sidebar of issues, alongside system fields like assignees, labels, and type. You can set values when creating or editing an issue. When you select an issue type while creating an issue, any fields pinned to that type automatically appear in the sidebar.
16
16
17
+
> [!NOTE]
18
+
> Issue fields are currently available on issues only. Pull requests do not support issue fields.
19
+
17
20
## Setting a field value
18
21
19
22
1. Navigate to the issue you want to update.
@@ -26,6 +29,9 @@ Issue fields appear in the right-hand sidebar of issues, alongside system fields
26
29
* For **date** fields, use the date picker to select a date, or type the date directly.
27
30
1. Changes are saved automatically.
28
31
32
+
> [!NOTE]
33
+
> Issue fields cannot currently be pre-filled via URL query parameters or set through issue templates. To set field values, use the issue sidebar, projects, the API, or {% data variables.product.prodname_actions %}.
34
+
29
35
## Editing a field value
30
36
31
37
1. Navigate to the issue.
@@ -87,3 +93,20 @@ Issue fields have full REST and GraphQL API support. You can automate field mana
87
93
***Managing fields**: Create, update, and delete organization-level fields. See the [Organization issue fields REST API](/rest/orgs/issue-fields).
88
94
***Using fields**: Get, set, and clear field values on individual issues. See the [Issue field values REST API](/rest/issues/issue-field-values).
89
95
***GraphQL**: Issue field types and mutations are also available via GraphQL. See the [`IssueFields` union](/graphql/reference/issues#union-issuefields), [issue field objects](/graphql/reference/issues#object-issuefieldtext) (such as `IssueFieldText`, `IssueFieldSingleSelect`, `IssueFieldNumber`, and `IssueFieldDate`), and [mutations](/graphql/reference/issues#mutation-createissuefield) (such as `createIssueField`, `updateIssueField`, and `setIssueFieldValue`).
96
+
97
+
## Automating with {% data variables.product.prodname_actions %}
98
+
99
+
Issue field changes trigger webhook events on the `issues` event. You can use these as workflow triggers:
100
+
101
+
*`field_added`: fires when a field value is set or updated.
102
+
*`field_removed`: fires when a field value is cleared.
103
+
104
+
For example, to run a workflow whenever a field value changes:
105
+
106
+
```yaml
107
+
on:
108
+
issues:
109
+
types: [field_added, field_removed]
110
+
```
111
+
112
+
The event payload includes the field name, type, value, and previous value. For more information, see [AUTOTITLE](/actions/reference/workflows-and-actions/events-that-trigger-workflows#issues).
| Start date | {% octicon "x" aria-label="Not pinned" %} | {% octicon "x" aria-label="Not pinned" %} | {% octicon "x" aria-label="Not pinned" %} | {% octicon "check" aria-label="Pinned" %} |
44
+
| Target date | {% octicon "x" aria-label="Not pinned" %} | {% octicon "x" aria-label="Not pinned" %} | {% octicon "x" aria-label="Not pinned" %} | {% octicon "check" aria-label="Pinned" %} |
45
+
37
46
These default fields are fully customizable. You can edit their names, descriptions, and options, or delete them if they don't fit your workflow.
38
47
48
+
> [!TIP]
49
+
> You can rename options, change their colors, reorder them, or add new values to match your team's workflow. For example, you could change Effort options to T-shirt sizes (XS, S, M, L, XL).
50
+
39
51
## Creating an issue field
40
52
41
53
{% data reusables.profile.access_org %}
@@ -73,6 +85,9 @@ When you delete an issue field, all values set on issues for that field are perm
73
85
1. To the right of the field you want to delete, click {% octicon "kebab-horizontal" aria-label="open field options" %}.
74
86
1. Click **Delete** and confirm the deletion.
75
87
88
+
> [!TIP]
89
+
> If you don't want to use issue fields, you can delete all default fields from your org settings. This removes them from all issues in your organization. You can re-create fields at any time.
90
+
76
91
## Reordering issue fields
77
92
78
93
The order of pinned fields is managed per issue type. The field order determines how fields appear in the issue sidebar and the issue creation modal.
@@ -100,6 +115,8 @@ Pinned fields automatically appear in the issue sidebar based on the selected is
100
115
> [!NOTE]
101
116
> Fields must be pinned to at least one issue type, or to "Issues without a type", to appear in the issue sidebar. Fields that are not pinned to any type are only accessible via the **Add field** button or in projects.
102
117
118
+
If a field is not appearing on your issues, check that it is pinned to the relevant issue type or to "Issues without a type". Fields that are not pinned and have no value set are hidden from the issue sidebar.
119
+
103
120
## Setting field visibility
104
121
105
122
For organizations with public repositories, you can control whether each issue field is visible to everyone or only to organization members and collaborators.
@@ -118,7 +135,22 @@ By default, all new and existing fields are set to "Organization only". Visibili
118
135
119
136
## Issue fields and projects
120
137
121
-
Issue fields are available in any project across your organization. For details on adding, removing, and editing issue fields in projects, see [AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/adding-and-managing-issue-fields#using-issue-fields-in-projects).
138
+
Issue fields are available in any project across your organization, including public and internal projects. For details on adding, removing, and editing issue fields in projects, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/understanding-fields/about-issue-fields).
139
+
140
+
### Visibility in public and internal projects
141
+
142
+
Only fields with **Public** visibility are available in public and internal projects. Fields set to **Organization only** are not displayed. When adding fields to a public project, only public-visibility fields appear in the add-field dialog.
143
+
144
+
If a field's visibility is changed from "Public" to "Organization only" while in use in a public project, the field is automatically removed from the project. To restore it, change the field's visibility back to "Public."
145
+
146
+
### Migrating from project fields to issue fields
147
+
148
+
If you already use project-level custom fields for metadata like priority or effort, you can adopt issue fields to centralize those values at the issue level.
149
+
150
+
* Issue fields are the source of truth. The value lives on the issue and is consistent across all projects the issue belongs to.
151
+
* Project fields are scoped to a single project. The same issue can have different project field values in different projects.
152
+
* Both can coexist. You do not need to remove project fields immediately, but having both can cause confusion if they track the same concept (for example, two "Priority" fields).
153
+
* To migrate, create the equivalent issue field, then remove the project-level field from your project views when your team is ready.
122
154
123
155
### Field limits in projects
124
156
@@ -129,6 +161,6 @@ Projects support up to 50 fields in total, and issue fields and system fields co
129
161
| Resource | Limit |
130
162
|----------|-------|
131
163
| Issue fields per organization | 25 |
132
-
| Options per single-select field |50|
164
+
| Options per single-select field |100|
133
165
| Pinned fields per issue type | 10 |
134
166
| Total fields in a project (including issue fields and system fields) | 50 |
0 commit comments