Skip to content

Commit 385b821

Browse files
labudisCopilot
andauthored
Add issue fields documentation for limited public preview (#59982)
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 51b6b0a commit 385b821

File tree

8 files changed

+311
-1
lines changed

8 files changed

+311
-1
lines changed
Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
---
2+
title: About issue fields in projects
3+
shortTitle: About issue fields
4+
intro: 'Learn how to use organization-level issue fields in your projects to track structured metadata like priority, effort, and dates.'
5+
versions:
6+
feature: issue-fields
7+
type: tutorial
8+
topics:
9+
- Projects
10+
- Issues
11+
---
12+
13+
{% data reusables.issues.issue-fields-public-preview-note %}
14+
15+
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).
16+
17+
> [!NOTE]
18+
> Issue fields are currently only supported in private projects. Issue fields are not available in public projects.
19+
20+
## Adding an issue field to a project
21+
22+
To display issue field values in a project:
23+
24+
1. Open a project and select a view using the table layout.
25+
1. Click {% octicon "plus" aria-label="Add field" %} in the table header.
26+
1. Click **Add field**.
27+
1. Select one or more issue fields from the list of available fields in the organization.
28+
1. Click **Add**.
29+
30+
The issue field appears as a column in the table view.
31+
32+
## Removing an issue field from a project
33+
34+
To remove an issue field from a project:
35+
36+
1. Click {% octicon "kebab-horizontal" aria-label="open field options" %} in the top right corner of the project page.
37+
1. Click **Settings**.
38+
1. In the left sidebar, select the issue field you want to remove.
39+
1. Click **Remove field**.
40+
41+
Removing an issue field from a project does not delete the field or its values from the organization. The field can be re-added at any time.
42+
43+
## Editing issue field values in a project
44+
45+
You can edit issue field values directly in the project table view without opening the issue. Click on a cell in the issue field column to set or change the value. Changes are synced back to the issue automatically.
46+
47+
## Grouping, filtering, and sorting
48+
49+
You can group, filter, and sort project views by issue field values, just like any other project field. This works in both table and board layouts.
50+
51+
You can also use issue fields to group by column on the board layout.
52+
53+
## Charts and insights
54+
55+
Issue fields are available as data sources in project charts. You can create charts that group or segment by issue field values to visualize trends across your organization.
56+
57+
## Limits
58+
59+
Projects support up to 50 fields in total. Issue fields and system fields count toward this limit. If a project is already at the field limit, you need to remove existing fields before issue fields can be added.
60+
61+
> [!NOTE]
62+
> Issue fields only apply to issues owned by the same organization. If a project contains pull requests, draft issues, or issues from another organization, issue field columns show empty cells for those items.

content/issues/planning-and-tracking-with-projects/understanding-fields/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ children:
99
- /about-date-fields
1010
- /about-single-select-fields
1111
- /about-iteration-fields
12+
- /about-issue-fields
1213
- /about-parent-issue-and-sub-issue-progress-fields
1314
- /about-pull-request-fields
1415
- /about-the-issue-type-field
Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
---
2+
title: Adding and managing issue fields
3+
intro: 'You can set, edit, and clear issue field values on individual issues to capture structured metadata for your team.'
4+
versions:
5+
feature: issue-fields
6+
type: how_to
7+
topics:
8+
- Project management
9+
shortTitle: 'Using issue fields'
10+
permissions: 'People with triage access or greater to a repository can set and edit issue field values.'
11+
---
12+
13+
{% data reusables.issues.issue-fields-public-preview-note %}
14+
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+
17+
## Setting a field value
18+
19+
1. Navigate to the issue you want to update.
20+
1. In the right sidebar, if the field you want is not already visible, click **Add field**.
21+
1. From the dropdown, select the field you want to add.
22+
1. Set the value:
23+
* For **single-select** fields, choose an option from the dropdown.
24+
* For **text** fields, type your value. URLs are automatically detected and displayed as links.
25+
* For **number** fields, enter a numeric value.
26+
* For **date** fields, use the date picker to select a date, or type the date directly.
27+
1. Changes are saved automatically.
28+
29+
## Editing a field value
30+
31+
1. Navigate to the issue.
32+
1. In the right sidebar, click on the field value you want to change.
33+
1. Select a new value or type a new entry.
34+
1. Changes are saved automatically.
35+
36+
## Clearing a field value
37+
38+
1. Navigate to the issue.
39+
1. In the right sidebar, click on the field value.
40+
1. Clear the value:
41+
* For **single-select** fields, click the currently selected option to deselect it.
42+
* For **text** and **number** fields, delete all text in the input.
43+
* For **date** fields, click the clear button in the date picker.
44+
1. After clearing, the field is removed from the sidebar. It can be re-added using the **Add field** button.
45+
46+
## Pinned fields
47+
48+
If your organization administrator has pinned fields to specific issue types, those fields automatically appear in the sidebar and the issue creation modal when you create or view an issue of that type. You do not need to manually add pinned fields.
49+
50+
## Viewing field changes in the timeline
51+
52+
When a field value is changed, the update is recorded in the issue timeline. The timeline entry shows:
53+
* Which field was changed
54+
* The new value that was set
55+
* Who made the change
56+
* When the change was made
57+
58+
Timeline events for fields set to "Organization only" visibility are hidden from users who are not organization members or collaborators.
59+
60+
## Field visibility
61+
62+
Organization administrators can set each field's visibility to "Organization only" or "Public". This affects what you see:
63+
64+
* If a field is set to **Organization only**, it is only visible to organization members and repository collaborators with at least read access. If you are not a member or collaborator, the field does not appear in the issue sidebar, timeline, or search suggestions.
65+
* If a field is set to **Public**, it is visible to anyone viewing the issue.
66+
67+
For more information about configuring visibility, see [AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-in-your-organization#setting-field-visibility).
68+
69+
## Using issue fields in projects
70+
71+
Issue fields can be added as columns in project views, where you can edit values, group, filter, sort, and build charts. For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/understanding-fields/about-issue-fields).
72+
73+
## Searching by field values
74+
75+
You can filter and search for issues based on field values on both the issues dashboard and your repository's issues page. In the search bar, type `field.` followed by the field name and value. For example:
76+
77+
* `field.priority:high` to find issues with priority set to "high"
78+
* `field."target date":>=2026-03-01` to find issues with a target date on or after March 1, 2026
79+
* `field.priority:high,medium` to find issues with priority set to "high" or "medium"
80+
81+
For more information, see [AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/filtering-and-searching-issues-and-pull-requests).
82+
83+
## Using issue fields with the API
84+
85+
Issue fields have full REST and GraphQL API support. You can automate field management, set values programmatically, and integrate with external tools.
86+
87+
- **Managing fields**: Create, update, and delete organization-level fields. See the [Organization issue fields REST API](/rest/orgs/issue-fields).
88+
- **Using fields**: Get, set, and clear field values on individual issues. See the [Issue field values REST API](/rest/issues/issue-field-values).

content/issues/tracking-your-work-with-issues/using-issues/filtering-and-searching-issues-and-pull-requests.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,22 @@ If your organization uses issue types, you can filter issues for a particular ty
144144

145145
{% endif %}
146146

147+
{% ifversion issue-fields %}
148+
149+
## Filtering by issue fields
150+
151+
If your organization uses issue fields, you can filter issues by field values. Type `field.` followed by the field name and value in your filter. Field names with spaces should be enclosed in quotes.
152+
153+
Examples:
154+
* `field.priority:high` -- find issues with priority set to "high"
155+
* `field."target date":>=2026-03-01` -- find issues with a target date on or after March 1, 2026
156+
* `field.story-points:>5` -- find issues with a number field value greater than 5
157+
* `field.priority:high,medium` -- find issues with priority set to "high" or "medium"
158+
159+
For more information about managing issue fields, see [AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-in-your-organization).
160+
161+
{% endif %}
162+
147163
## Filtering pull requests by review status
148164

149165
You can use filters to list pull requests by review status and to find pull requests that you've reviewed or other people have asked you to review.
@@ -222,7 +238,8 @@ For issues, you can also use search to:
222238

223239
* Filter for issues that are linked to a pull request by a closing reference: `linked:pr`
224240
* Filter issues by the reason they were closed: `is:closed reason:completed` or `is:closed reason:"not planned"`
225-
{% ifversion issue-types %}* Filter for issues with a particular type: `is:open type:"Bug"`{% endif %}{% ifversion issues-advanced-search %}
241+
{% ifversion issue-types %}* Filter for issues with a particular type: `is:open type:"Bug"`{% endif %}{% ifversion issue-fields %}
242+
* Filter for issues by field value: `is:open field.priority:high`{% endif %}{% ifversion issues-advanced-search %}
226243
* Filter for issues that have metadata: `has:label`
227244
* Filter for issues that are missing metadata: `no:project`
228245
* Filter for issues from repositories [**owned**](/search-github/searching-on-github/searching-issues-and-pull-requests#search-within-a-users-or-organizations-repositories) by a certain user or organization, limited to up to 16 `user` and `org` qualifiers with no limit on `repo` qualifiers: `state:open is:issue org:github OR user:octocat`{% endif %}

content/issues/tracking-your-work-with-issues/using-issues/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,6 @@ children:
1818
- /linking-a-pull-request-to-an-issue
1919
- /about-slash-commands
2020
- /managing-issue-types-in-an-organization
21+
- /managing-issue-fields-in-your-organization
22+
- /adding-and-managing-issue-fields
2123
---
Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
---
2+
title: Managing issue fields in your organization
3+
intro: 'You can create and manage custom issue fields to collect structured metadata across all issues in your organization.'
4+
redirect_from:
5+
- /issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-in-an-organization
6+
versions:
7+
feature: issue-fields
8+
type: overview
9+
topics:
10+
- Project management
11+
shortTitle: 'Managing issue fields'
12+
permissions: 'Organization owners can create and manage issue fields.'
13+
---
14+
15+
{% data reusables.issues.issue-fields-public-preview-note %}
16+
17+
Issue fields let you add structured metadata to issues across your organization. Instead of relying on labels or free-text workarounds, you can create fields like priority, effort, impact, or any custom category your team needs. Fields are defined at the organization level and apply across all repositories in your organization.
18+
19+
## About issue field types
20+
21+
You can create up to 25 issue fields per organization. The following field types are available:
22+
23+
* **Single-select**: choose one option from a predefined list. Options can have names, descriptions, and colors.
24+
* **Text**: capture free-form text. URLs are automatically detected and displayed as clickable links.
25+
* **Number**: accept numeric input, including decimals.
26+
* **Date**: provide a date picker for selecting dates.
27+
28+
## Default fields
29+
30+
When issue fields are enabled for your organization, four default fields are created automatically:
31+
32+
* **Priority** (single-select): Urgent, High, Medium, Low
33+
* **Effort** (single-select): High, Medium, Low
34+
* **Start date** (date)
35+
* **Target date** (date)
36+
37+
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+
39+
## Creating an issue field
40+
41+
{% data reusables.profile.access_org %}
42+
{% data reusables.profile.org_settings %}
43+
1. In the "Planning" section of the sidebar, click **Issue fields**.
44+
1. Click **New field**.
45+
1. Under "Field name", type the name of your new field.
46+
1. Optionally, under "Description", type a description to help others understand the purpose of the field.
47+
1. Under "Field type", select the type of field you want to create.
48+
1. If you selected **Single-select**, add options for the field:
49+
* Click **Add option** and type the option name.
50+
* Optionally, to set a color for an option, click {% octicon "kebab-horizontal" aria-label="open option menu" %} next to the option, click **Edit option**, choose a color, and click **Save**.
51+
* Repeat to add more options.
52+
1. Under "Field Visibility", choose one of the following:
53+
* **Permissions**: choose who can see the field and its value. Options are **Organization only** (default) or **Public**. This setting only applies to issues in public repositories.
54+
* **Pin to types**: click {% octicon "pencil" aria-label="edit pinning" %} to choose which issue types show this field in the issue viewer and creator. Select one or more issue types, or "Issues without a type". Fields that are not pinned and have no value will stay hidden in the issue viewer and creator.
55+
1. Click **Create**.
56+
57+
## Editing an issue field
58+
59+
{% data reusables.profile.access_org %}
60+
{% data reusables.profile.org_settings %}
61+
1. In the "Planning" section of the sidebar, click **Issue fields**.
62+
1. To the right of the field you want to edit, click {% octicon "kebab-horizontal" aria-label="open field options" %}.
63+
1. Click **Edit** and make your changes.
64+
1. Click **Save field**.
65+
66+
## Deleting an issue field
67+
68+
When you delete an issue field, all values set on issues for that field are permanently removed.
69+
70+
{% data reusables.profile.access_org %}
71+
{% data reusables.profile.org_settings %}
72+
1. In the "Planning" section of the sidebar, click **Issue fields**.
73+
1. To the right of the field you want to delete, click {% octicon "kebab-horizontal" aria-label="open field options" %}.
74+
1. Click **Delete** and confirm the deletion.
75+
76+
## Reordering issue fields
77+
78+
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.
79+
80+
{% data reusables.profile.access_org %}
81+
{% data reusables.profile.org_settings %}
82+
1. In the "Planning" section of the sidebar, click **Issue types**.
83+
1. Click the issue type you want to reorder fields for.
84+
1. Under "Pinned issue fields", drag fields to reorder them.
85+
1. Click **Save**.
86+
87+
## Pinning fields to issue types
88+
89+
You can associate issue fields with specific issue types so that only the most relevant fields appear when creating or viewing issues of that type. For example, you can pin "Severity" to bugs and "Impact" to features.
90+
91+
{% data reusables.profile.access_org %}
92+
{% data reusables.profile.org_settings %}
93+
1. In the "Planning" section of the sidebar, click **Issue fields**.
94+
1. Click the field you want to pin.
95+
1. Under "Pin to types", click {% octicon "pencil" aria-label="edit pinning" %} and select the issue types this field should appear on.
96+
1. Click **Save field**.
97+
98+
Pinned fields automatically appear in the issue sidebar based on the selected issue type. To pin fields to issues that have no type, select the "Issues without a type" option.
99+
100+
> [!NOTE]
101+
> 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+
103+
## Setting field visibility
104+
105+
For organizations with public repositories, you can control whether each issue field is visible to everyone or only to organization members and collaborators.
106+
107+
{% data reusables.profile.access_org %}
108+
{% data reusables.profile.org_settings %}
109+
1. In the "Planning" section of the sidebar, click **Issue fields**.
110+
1. To the right of the field, click {% octicon "kebab-horizontal" aria-label="open field options" %}.
111+
1. Click **Edit**.
112+
1. Under "Field Visibility", choose one of the following:
113+
* **Organization only**: the field is visible only to organization members and repository collaborators with at least read access.
114+
* **Public**: the field is visible to anyone viewing the issue.
115+
1. Click **Save**.
116+
117+
By default, all new and existing fields are set to "Organization only". Visibility settings are enforced across the web UI, API, issue timeline events, and search suggestions.
118+
119+
## Issue fields and projects
120+
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).
122+
123+
### Field limits in projects
124+
125+
Projects support up to 50 fields in total, and issue fields and system fields count toward this limit. If a project is already at the field limit, you need to remove existing fields before issue fields can be added.
126+
127+
## Limits
128+
129+
| Resource | Limit |
130+
|----------|-------|
131+
| Issue fields per organization | 25 |
132+
| Options per single-select field | 50 |
133+
| Pinned fields per issue type | 10 |
134+
| Total fields in a project (including issue fields and system fields) | 50 |

data/features/issue-fields.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Reference: github/releases#7336
2+
versions:
3+
fpt: '*'
4+
ghec: '*'
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
> [!NOTE]
2+
> Issue fields are currently in {% data variables.release-phases.public_preview %} and subject to change. To share feedback, see the [community discussion](https://github.com/orgs/community/discussions/189141).

0 commit comments

Comments
 (0)