1
0
mirror of synced 2025-12-19 18:10:59 -05:00

Hack week 2025: remove unneeded FBV instances (8) - Issues, Enterprise, and custom repo roles (#53935)

This commit is contained in:
mc
2025-01-16 07:19:38 +00:00
committed by GitHub
parent afd9692014
commit cdb90bb2ae
22 changed files with 27 additions and 76 deletions

View File

@@ -49,7 +49,7 @@ You can also view whether an enterprise owner has a specific role in the organiz
| Enterprise owner | Organization owner | Able to configure organization settings and manage access to the organization's resources through teams, etc. |
| Enterprise owner | Organization member | Able to access organization resources and content, such as repositories, without access to the organization's settings. |
To review all roles in an organization, see [AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization). {% ifversion custom-repository-roles %} An organization member can also have a custom role for a specific repository. For more information, see [AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/managing-custom-repository-roles-for-an-organization).{% endif %}
To review all roles in an organization, see [AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization). {% ifversion ghec or ghes %} An organization member can also have a custom role for a specific repository. For more information, see [AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/managing-custom-repository-roles-for-an-organization).{% endif %}
For more information about the enterprise owner role, see [AUTOTITLE](/admin/managing-accounts-and-repositories/managing-users-in-your-enterprise/roles-in-an-enterprise#enterprise-owner).

View File

@@ -617,12 +617,10 @@ $ ghe-cluster-maintenance -q
# Queries the current mode
$ ghe-cluster-maintenance -s
# Sets maintenance mode
{%- ifversion custom-maintenance-mode-message %}
$ ghe-cluster-maintenance -s "MESSAGE"
# Sets maintenance mode with a custom message
$ ghe-cluster-maintenance -m "MESSAGE"
# Updates the custom message
{%- endif %}
$ ghe-cluster-maintenance -u
# Unsets maintenance mode
```

View File

@@ -50,12 +50,11 @@ You can perform initial validation of your maintenance operation by configuring
1. In the top navigation bar, click **Maintenance**.
![Screenshot of the header of the {% data variables.enterprise.management_console %}. A tab, labeled "Maintenance", is highlighted with an orange outline.](/assets/images/enterprise/management-console/maintenance-tab.png)
1. Under "Enable and schedule", {% ifversion custom-maintenance-mode-message %}select **Enable maintenance mode**, then {% endif %}decide whether to enable maintenance mode immediately or to schedule a maintenance window for a future time.
1. Under "Enable and schedule", select **Enable maintenance mode**, then decide whether to enable maintenance mode immediately or to schedule a maintenance window for a future time.
* To enable maintenance mode immediately, select the dropdown menu and click **now**.
* To schedule a maintenance window for a future time, select the dropdown menu and click a start time.
{% data reusables.enterprise_management_console.custom-maintenance-message %}
{% ifversion custom-maintenance-mode-message %}1. When you're satisfied with the timing of the window and the optional message, click **Save**. If you selected "now", your instance will be put into maintenance mode immediately.
{% else %}1. When you're satisfied with the timing of the window, select the checkbox next to "Enable maintenance mode". If you selected "now", your instance will be put into maintenance mode immediately.{% endif %}
1. When you're satisfied with the timing of the window and the optional message, click **Save**. If you selected "now", your instance will be put into maintenance mode immediately.
{% ifversion ip-exception-list %}
@@ -103,8 +102,6 @@ For more information, see [AUTOTITLE](/admin/administering-your-instance/adminis
{% endif %}
{% ifversion custom-maintenance-mode-message %}
## Managing maintenance mode using SSH
If you have SSH access, you can use the `ghe-maintenance` command line utility to can set or unset maintenance mode for a {% data variables.product.product_name %} instance with one node, or multiple nodes in a high-availability configuration. For more information, see [AUTOTITLE](/admin/administering-your-instance/administering-your-instance-from-the-command-line/accessing-the-administrative-shell-ssh) and [AUTOTITLE](/admin/administering-your-instance/administering-your-instance-from-the-command-line/command-line-utilities#ghe-maintenance).
@@ -120,14 +117,10 @@ $ ghe-cluster-maintenance -q
# Queries the current mode
$ ghe-cluster-maintenance -s
# Sets maintenance mode
{%- ifversion custom-maintenance-mode-message %}
$ ghe-cluster-maintenance -s "MESSAGE"
# Sets maintenance mode with a custom message
$ ghe-cluster-maintenance -m "MESSAGE"
# Updates the custom message
{%- endif %}
$ ghe-cluster-maintenance -u
# Unsets maintenance mode
```
{% endif %}

View File

@@ -107,8 +107,7 @@ Each time a user sees a mandatory message, an audit log event is created. The ev
You can set a global announcement banner to be displayed to all users at the top of every page{% ifversion ghec %} within your enterprise, including every page in every organization owned by the enterprise{% endif %}.
{% ifversion custom-banner-messages %}
You can also create announcement banners at the organization level. For more information, see [AUTOTITLE](/organizations/managing-organization-settings/creating-an-announcement-banner-for-your-organization).{% endif %}
You can also create announcement banners at the organization level. For more information, see [AUTOTITLE](/organizations/managing-organization-settings/creating-an-announcement-banner-for-your-organization).
{% ifversion ghes %}
You can also set an announcement banner{% ifversion ghes %} in the administrative shell using a command line utility or{% endif %} using the API. For more information, see {% ifversion ghes %}[AUTOTITLE](/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-announce) and {% endif %}[AUTOTITLE](/rest/enterprise-admin#announcements).
@@ -116,19 +115,9 @@ You can also set an announcement banner{% ifversion ghes %} in the administrativ
{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.settings-tab %}
{% data reusables.enterprise-accounts.messages-tab %}{% ifversion custom-banner-messages %}{% else %}
1. To the right of "Announcement", click **Add announcement**.{% endif %}
1. Under "Announcement", in the text field, type the announcement you want displayed in a banner.
1. Optionally, under "Expires on", select the calendar drop-down menu and click an expiration date.
{% ifversion ghe-announce-dismiss %}
> [!NOTE]
> Announcements must either have an expiration date, be user dismissible, or both.
{% endif %}
{% data reusables.enterprise-accounts.messages-tab %}
{%- ifversion ghe-announce-dismiss %}
1. Optionally, to allow each user to dismiss the announcement, select **User dismissible**.
{%- endif %}{% ifversion custom-banner-messages %}
1. Optionally, to allow each user to dismiss the announcement, select **Allow users to dismiss the announcement**.
{%- endif %}
1. Optionally, to allow each user to dismiss the announcement, select **Allow users to dismiss the announcement**.
{% data reusables.enterprise_site_admin_settings.message-preview-save %}

View File

@@ -60,10 +60,9 @@ Before defining a custom pattern, you must ensure that {% data variables.product
{% data reusables.repositories.navigate-to-code-security-and-analysis %}
{% data reusables.repositories.navigate-to-ghas-settings %}
{% data reusables.advanced-security.secret-scanning-new-custom-pattern %}
{% data reusables.advanced-security.secret-scanning-add-custom-pattern-details %}{% ifversion custom-pattern-dry-run-ga %}
{% data reusables.advanced-security.secret-scanning-add-custom-pattern-details %}
1. When you're ready to test your new custom pattern, to identify matches in the repository without creating alerts, click **Save and dry run**.
{% data reusables.advanced-security.secret-scanning-dry-run-results %}
{% endif %}
{% data reusables.advanced-security.secret-scanning-create-custom-pattern %}{% ifversion secret-scanning-push-protection-custom-patterns %}
1. Optionally, to enable push protection for your custom pattern, click **Enable**.
@@ -121,11 +120,9 @@ To enable {% data variables.product.prodname_secret_scanning %} on all repositor
{% endif %}
{% data reusables.advanced-security.secret-scanning-new-custom-pattern-org %}
{% data reusables.advanced-security.secret-scanning-add-custom-pattern-details %}
{%- ifversion custom-pattern-dry-run-ga %}
1. When you're ready to test your new custom pattern, to identify matches in select repositories without creating alerts, click **Save and dry run**.
{% data reusables.advanced-security.secret-scanning-dry-run-select-repos %}
{% data reusables.advanced-security.secret-scanning-dry-run-results %}
{%- endif %}
{% data reusables.advanced-security.secret-scanning-create-custom-pattern %}{% ifversion secret-scanning-push-protection-custom-patterns %}
1. Optionally, to enable push protection for your custom pattern, click **Enable**. For more information, see [AUTOTITLE](/code-security/secret-scanning/protecting-pushes-with-secret-scanning#enabling-secret-scanning-as-a-push-protection-in-an-organization-for-a-custom-pattern).
@@ -147,11 +144,9 @@ Before defining a custom pattern, you must ensure that you enable secret scannin
1. Under "{% ifversion code-security-wording-only-enterprise %}Code security{% else %}Code security and analysis{% endif %}", click **Security features**.
1. Under "Secret scanning custom patterns", click **New pattern**.
{% data reusables.advanced-security.secret-scanning-add-custom-pattern-details %}
{%- ifversion custom-pattern-dry-run-ga %}
1. When you're ready to test your new custom pattern, to identify matches in the enterprise without creating alerts, click **Save and dry run**.
{% data reusables.advanced-security.secret-scanning-dry-run-select-enterprise-repos %}
{% data reusables.advanced-security.secret-scanning-dry-run-results %}
{%- endif %}
{% data reusables.advanced-security.secret-scanning-create-custom-pattern %}{% ifversion secret-scanning-push-protection-custom-patterns %}
1. Optionally, to enable push protection for your custom pattern, click **Enable**. For more information, see [AUTOTITLE](/code-security/secret-scanning/protecting-pushes-with-secret-scanning).
{% indented_data_reference reusables.secret-scanning.push-protection-enterprise-note spaces=3 %}{% endif %}

View File

@@ -22,9 +22,7 @@ When you save a change to a custom pattern, this closes all the {% data variable
{% data reusables.secret-scanning.view-custom-pattern %}
1. Under "{% data variables.product.prodname_secret_scanning_caps %}", to the right of the custom pattern you want to edit, click {% octicon "pencil" aria-label="Edit pattern" %}.
{%- ifversion custom-pattern-dry-run-ga %}
1. When you're ready to test your edited custom pattern, to identify matches without creating alerts, click **Save and dry run**.
{%- endif %}
1. When you have reviewed and tested your changes, click **Publish changes**.{% ifversion secret-scanning-push-protection-custom-patterns %}
{% data reusables.advanced-security.secret-scanning-enable-push-protection-custom-pattern %}
1. Optionally, to disable push protection for your custom pattern, click **Disable**.
@@ -52,7 +50,7 @@ You can enable {% data variables.product.prodname_secret_scanning %} as a push p
{% data reusables.secret-scanning.push-protection-enterprise-note %}
Before enabling push protection for a custom pattern at enterprise level, you must also{% ifversion custom-pattern-dry-run-ga %} test your custom patterns using dry runs. {% data reusables.secret-scanning.dry-runs-enterprise-permissions %}{% else %} test your custom patterns in a repository before defining them for your entire enterprise, as there is no dry-run functionality. That way, you can avoid creating excess false-positive {% data variables.secret-scanning.alerts %}.{% endif %}
Before enabling push protection for a custom pattern at enterprise level, you must also test your custom patterns using dry runs. {% data reusables.secret-scanning.dry-runs-enterprise-permissions %}
{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.policies-tab %}
@@ -60,9 +58,7 @@ Before enabling push protection for a custom pattern at enterprise level, you mu
1. Under "{% ifversion code-security-wording-only-enterprise %}Code security{% else %}Code security and analysis{% endif %}", click **Security features**.
{% data reusables.advanced-security.secret-scanning-edit-custom-pattern %}
{% ifversion custom-pattern-dry-run-ga %}
>[!NOTE] At the enterprise level, you can only edit and enable push protection for custom patterns that you created.
{%- endif %}
1. To enable push protection for your custom pattern, scroll down to "Push Protection", and click **Enable**.

View File

@@ -180,8 +180,6 @@ To transfer a discussion, you must have permissions to create discussions in the
{% endif %}
{% ifversion converting-issues-to-discussions %}
## Converting issues based on labels
You can convert all issues with the same label to discussions in bulk. Future issues with this label will also automatically convert to the discussion and category you configure.
@@ -192,4 +190,3 @@ You can convert all issues with the same label to discussions in bulk. Future is
1. Next to the label you want to convert to issues, click **Convert issues**.
1. Select the **Choose a category** drop-down menu, and click a category for your discussion.
1. Click **I understand, convert this issue to a discussion**.
{% endif %}

View File

@@ -38,8 +38,6 @@ It's appropriate to lock a conversation when the entire conversation is not cons
1. To lock the conversation, click **Lock conversation**.
1. When you're ready to unlock the conversation, click **Unlock conversation** in the right margin of a discussion, then click **Unlock conversation**.
{% ifversion converting-issues-to-discussions %}
## Converting an issue to a discussion
When you convert an issue to a discussion, the discussion is automatically created using the content from the issue. People with write access to a repository, or source repository for organization discussions, can bulk convert issues based on labels. For more information, see [AUTOTITLE](/discussions/managing-discussions-for-your-community/managing-discussions).
@@ -50,7 +48,6 @@ When you convert an issue to a discussion, the discussion is automatically creat
1. In the right margin of an issue, click **Convert to discussion**.
1. Select the **Choose a category** drop-down menu, and click a category for your discussion.
1. Click **I understand, convert this issue to a discussion**.
{% endif %}
{% ifversion discussions-hide-comments-on-block %}

View File

@@ -60,5 +60,6 @@ You can @mention collaborators who have access to your repository in an issue to
Some conversations are more suitable for {% data variables.product.prodname_discussions %}. {% data reusables.discussions.you-can-use-discussions %} For guidance on when to use an issue or a discussion, see [AUTOTITLE](/get-started/using-github/communicating-on-github).
{% ifversion converting-issues-to-discussions %}When a conversation in an issue is better suited for a discussion, you can convert the issue to a discussion.{% endif %}
When a conversation in an issue is better suited for a discussion, you can convert the issue to a discussion.
{% endif %}

View File

@@ -123,7 +123,7 @@ To search for specific events, use the `action` qualifier in your query. Actions
| {% ifversion fpt or ghec %} |
| `repository_vulnerability_alerts` | Contains repository-level configuration activities for {% data variables.product.prodname_dependabot_alerts %}.
| {% endif %} |
| {% ifversion custom-repository-roles %} |
| {% ifversion ghec or ghes %} |
| `role` | Contains all activities related to [custom repository roles](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/managing-custom-repository-roles-for-an-organization).
| {% endif %} |
| {% ifversion ghes or ghec %} |

View File

@@ -3,7 +3,8 @@ title: Creating an announcement banner for your organization
shortTitle: Create an announcement banner
intro: Organization owners can create announcement banners for the organization.
versions:
feature: custom-banner-messages
ghes: '*'
ghec: '*'
type: how_to
topics:
- Maintenance

View File

@@ -2,7 +2,9 @@
title: Managing the commit signoff policy for your organization
intro: 'You can require users to automatically sign off all commits they make in {% data variables.product.product_name %}''s web interface to repositories owned by your organization.'
versions:
feature: commit-signoffs
fpt: '*'
ghec: '*'
ghes: '*'
permissions: Organization owners can require all commits to repositories owned by the organization be signed off by the commit author.
topics:
- Organizations

View File

@@ -2,7 +2,8 @@
title: About custom repository roles
intro: You can more granularly control access to your organization's repositories with custom repository roles.
versions:
feature: custom-repository-roles
ghes: '*'
ghec: '*'
topics:
- Organizations
- Teams
@@ -23,12 +24,8 @@ You can have more granular control over the permissions you grant at the reposit
After you create a custom role, anyone with admin access to a repository can assign the role to an individual or team. For more information, see [AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/managing-an-individuals-access-to-an-organization-repository) and [AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/managing-team-access-to-an-organization-repository).
{% ifversion custom-repo-role-api %}
You can also use the REST API to create and manage custom repository roles. For more information, see [AUTOTITLE](/rest/orgs/custom-roles).
{% endif %}
{% ifversion custom-org-roles %}
Custom repository roles manage access to specific repositories in your organization. To {% ifversion org-custom-role-with-repo-permissions %}grant access to all repositories, and to {% endif %}control access to your organization's administration settings, you can use custom organization roles. See [AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).

View File

@@ -3,7 +3,8 @@ title: Managing custom repository roles for an organization
intro: 'Learn how to create, edit, or delete custom repository roles for your organization.'
permissions: Organization owners.
versions:
feature: custom-repository-roles
ghes: '*'
ghec: '*'
topics:
- Organizations
- Teams

View File

@@ -24,7 +24,7 @@ You can set base permissions that apply to all members of an organization when a
If someone with admin access to an organization's repository grants a member a higher level of access for the repository, the higher level of access overrides the base permission.
{% ifversion custom-repository-roles %}
{% ifversion ghec or ghes %}
If you've created a custom repository role with an inherited role that is lower access than your organization's base permissions, any members assigned to that role will default to the organization's base permissions rather than the inherited role. For more information, see [AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/managing-custom-repository-roles-for-an-organization).
{% endif %}

View File

@@ -16,8 +16,7 @@ versions:
{% data reusables.commits.about-commits %}
{% ifversion commit-signoffs %}
If the repository you are committing to has compulsory commit signoffs enabled, and you are committing via the web interface, you will automatically sign off on the commit as part of the commit process. For more information, see [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-commit-signoff-policy-for-your-repository). {% endif %}
If the repository you are committing to has compulsory commit signoffs enabled, and you are committing via the web interface, you will automatically sign off on the commit as part of the commit process. For more information, see [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-commit-signoff-policy-for-your-repository).
You can add a co-author on any commits you collaborate on. For more information, see [AUTOTITLE](/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors).
@@ -43,8 +42,6 @@ Once the commit is on the default branch, any tags that contain the commit will
![Screenshot of a commit summary. The tag icon and "v2.3.4" are highlighted with an orange outline.](/assets/images/help/commits/commit-tag-label.png)
{% ifversion commit-tree-view %}
## Using the file tree
You can use the file tree to navigate between files in a commit.
@@ -60,8 +57,6 @@ You can use the file tree to navigate between files in a commit.
![Screenshot of the "Files changed" tab of a pull request. In the left sidebar, the file tree is outlined in dark orange.](/assets/images/help/repository/file-tree.png)
1. To filter by file path, enter part or all of the file path in the **Filter changed files** search box.
{% endif %}
## Further reading
* [AUTOTITLE](/desktop/making-changes-in-a-branch/committing-and-reviewing-changes-to-your-project-in-github-desktop#about-commits) on {% data variables.product.prodname_desktop %}

View File

@@ -10,8 +10,7 @@ versions:
When you add a tag protection rule, all tags that match the pattern provided will be protected. Only users with admin or maintain permissions, or custom roles with the "edit repository rules" permission in the repository will be able to create protected tags, and only users with admin permissions or custom roles with the "edit repository rules" permission in the repository will be able to delete protected tags. For more information, see [AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization#permissions-for-each-role). {% data variables.product.prodname_github_apps %} require the `Repository administration: write` permission to modify a protected tag.
{% ifversion custom-repository-roles %}
Additionally, you can create custom repository roles to allow other groups of users to create or delete tags that match tag protection rules. For more information, see [AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/managing-custom-repository-roles-for-an-organization).{% endif %}
Additionally, you can create custom repository roles to allow other groups of users to create or delete tags that match tag protection rules. For more information, see [AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/managing-custom-repository-roles-for-an-organization).
{% ifversion tag-protection-rules-import %}

View File

@@ -2,7 +2,9 @@
title: Managing the commit signoff policy for your repository
intro: 'You can require users to automatically sign off on the commits they make to your repository using {% data variables.product.product_name %}''s web interface.'
versions:
feature: commit-signoffs
fpt: '*'
ghec: '*'
ghes: '*'
permissions: Organization owners and repository administrators can require all commits to a repository to be signed off by the commit author.
topics:
- Repositories

View File

@@ -1,7 +1,2 @@
{%- ifversion custom-pattern-dry-run-ga %}
1. Search for and select up to 10 repositories where you want to perform the dry run.
1. When you're ready to test your new custom pattern, click **Run**.
{%- else %}
1. Search for and select up to 10 repositories where you want to perform the dry run.
1. When you're ready to test your new custom pattern, click **Dry run**.
{%- endif %}

View File

@@ -1,9 +1,4 @@
{%- ifversion custom-pattern-dry-run-ga %}
1. Select the repositories where you want to perform the dry run.
* To perform the dry run across the entire organization, select **All repositories in the organization**.
* To specify the repositories where you want to perform the dry run, select **Selected repositories**, then search for and select up to 10 repositories.
1. When you're ready to test your new custom pattern, click **Run**.
{%- else %}
1. Search for and select up to 10 repositories where you want to perform the dry run.
1. When you're ready to test your new custom pattern, click **Dry run**.
{%- endif %}

View File

@@ -153,7 +153,7 @@
| {% ifversion ghec or ghes %} |
| `restrict_notification_delivery` | Contains activities related to the restriction of email notifications to approved or verified domains for an enterprise. |
| {% endif %} |
| {% ifversion custom-repository-roles %} |
| {% ifversion ghec or ghes %} |
| `role` | Contains activities related to [custom repository roles](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/managing-custom-repository-roles-for-an-organization). |
| {% endif %} |
| {% ifversion ghec or ghes %} |

View File

@@ -1,3 +1 @@
{%- ifversion custom-maintenance-mode-message %}
1. Optionally, to set a custom message for users to see during the maintenance window, in the "Set a maintenance mode message" field, type a message.
{%- endif %}