Ruleset management [Public Beta] (#42101)

Co-authored-by: github-actions <[email protected]>
Co-authored-by: Isaac Brown <[email protected]>

Author: 3 people

assets/images/help/repository/import-a-ruleset.png

@@ -17,6 +17,12 @@ When you create a ruleset for an organization, you use `fnmatch` syntax to defin
 
 Forks do not inherit rulesets from their upstream repositories. However, forks owned by your organization are subject to the rulesets you create, like any other repository.
 
+{% ifversion repo-rules-management %}
+
+{% data reusables.repositories.import-a-ruleset-conceptual %} For more information, see "[AUTOTITLE](/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#using-ruleset-history)."
+
+{% endif %}
+
 To create a ruleset, complete the following procedures:
 
 - [Creating a branch or tag ruleset](#creating-a-branch-or-tag-ruleset)

assets/images/help/repository/ruleset-history-options.png

@@ -35,6 +35,30 @@ You can use the REST and GraphQL APIs to manage rulesets. For more information,
 {% data reusables.organizations.access-ruleset-settings %}
 {% data reusables.repositories.delete-ruleset-steps %}
 
+{% ifversion repo-rules-management %}
+
+## Using ruleset history
+
+{% data reusables.repositories.ruleset-beta-note %}
+
+{% data reusables.repositories.ruleset-history-conceptual %}
+
+{% data reusables.profile.access_org %}
+{% data reusables.profile.org_settings %}
+{% data reusables.organizations.access-ruleset-settings %}
+{% data reusables.repositories.ruleset-history %}
+
+### Importing a ruleset
+
+You can import a ruleset from another repository or organization using the exported JSON file from the previous section. This can be useful if you want to apply the same ruleset to multiple repositories or organizations.
+
+{% data reusables.profile.access_org %}
+{% data reusables.profile.org_settings %}
+{% data reusables.organizations.access-ruleset-settings %}
+{% data reusables.repositories.import-a-ruleset %}
+
+{% endif %}
+
 ## Viewing insights for rulesets
 
 You can view insights for rulesets to see how rulesets are affecting the repositories in your organization. {% data reusables.repositories.about-ruleset-insights %}
@@ -44,5 +68,6 @@ You can view insights for rulesets to see how rulesets are affecting the reposit
 1. In the left sidebar, in the "Code, planning, and automation" section, click **{% octicon "repo" aria-hidden="true" %} Repository**, then click **Repository rule insights**.
 
    ![Screenshot of an organization's settings page. In the sidebar, a link labeled "Repository rule insights" is outlined in orange.](/assets/images/help/organizations/repository-rule-insights.png)
+
 1. On the "Rule Insights" page, use the dropdown menus at the top of the page to filter the actions by ruleset, repository, actor, and time period.
 {% data reusables.repositories.rulesets-view-rule-runs %}

assets/images/help/repository/ruleset-history.png

@@ -14,6 +14,9 @@ shortTitle: Create a ruleset
 
 You can create rulesets to control how users can interact with selected branches and tags in a repository. When you create a ruleset, you can allow certain users to bypass the rules in the ruleset. This can be users with certain permissions, specific teams, or {% data variables.product.prodname_github_apps %}. For more information on rulesets, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/about-rulesets)."
 
+{% ifversion repo-rules-management %}
+{% data reusables.repositories.import-a-ruleset-conceptual %} For more information, see "[AUTOTITLE](/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#using-ruleset-history)."{% endif %}
+
 {% ifversion repo-rules-enterprise %}
 You can also create rulesets for all repositories in an organization. For more information, see "[AUTOTITLE](/organizations/managing-organization-settings/creating-rulesets-for-repositories-in-your-organization)."{% endif %}
 

content/organizations/managing-organization-settings/creating-rulesets-for-repositories-in-your-organization.md

@@ -62,6 +62,30 @@ Anyone with read access to a repository can view the rulesets targeting the repo
 {% data reusables.repositories.repo-rulesets-settings %}
 {% data reusables.repositories.delete-ruleset-steps %}
 
+{% ifversion repo-rules-management %}
+
+## Using ruleset history
+
+{% data reusables.repositories.ruleset-beta-note %}
+
+{% data reusables.repositories.ruleset-history-conceptual %}
+
+{% data reusables.repositories.navigate-to-repo %}
+{% data reusables.repositories.sidebar-settings %}
+{% data reusables.repositories.repo-rulesets-settings %}
+{% data reusables.repositories.ruleset-history %}
+
+### Importing a ruleset
+
+{% data reusables.repositories.import-a-ruleset-conceptual %}
+
+{% data reusables.repositories.navigate-to-repo %}
+{% data reusables.repositories.sidebar-settings %}
+{% data reusables.repositories.repo-rulesets-settings %}
+{% data reusables.repositories.import-a-ruleset %}
+
+{% endif %}
+
 {% ifversion repo-rules-enterprise %}
 
 ## Viewing insights for rulesets

content/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization.md

@@ -0,0 +1,5 @@
+# Reference: #11915
+# Ruleset management public beta
+versions:
+  ghec: '*'
+  ghes: '>=3.12'

content/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/creating-rulesets-for-a-repository.md

@@ -0,0 +1 @@
+You can import a ruleset from another repository or organization using a JSON file. This can be useful if you want to apply the same ruleset to multiple repositories or organizations.

content/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository.md

@@ -0,0 +1,6 @@
+1. Select the **New ruleset** dropdown, then click **Import a ruleset**.
+
+   ![Screenshot of the page for repository rulesets. A dropdown menu labeled "New ruleset" is expanded and the "Import a ruleset" option is highlighted with an orange outline.](/assets/images/help/repository/import-a-ruleset.png)
+
+1. Open the exported JSON file.
+1. Review the imported ruleset and click **Create**.

data/features/repo-rules-management.yml

@@ -0,0 +1,8 @@
+{% note %}
+
+**Notes:**
+
+- Ruleset history is currently in public beta and subject to change.
+- Only changes made to a ruleset after the public beta release, on October 11, 2023, are included in the ruleset history.
+
+{% endnote %}

data/reusables/repositories/import-a-ruleset-conceptual.md

@@ -0,0 +1 @@
+You can view all the changes to a ruleset and revert back to a specific iteration. You can also download a JSON file containing the ruleset's configuration at a specific iteration. The bypass list of a ruleset is excluded from the exported JSON file.

data/reusables/repositories/import-a-ruleset.md

@@ -0,0 +1,7 @@
+1. To view the history of changes to the ruleset, select {% octicon "kebab-horizontal" aria-label="Open additional options" %} to the right of the ruleset's name, then click **{% octicon "history" aria-hidden="true" %} History**.
+
+   ![Screenshot of the page for repository rulesets. Below a button labeled with three dots, an option labeled "History" is outlined in orange.](/assets/images/help/repository/ruleset-history.png)
+
+1. To the right of the specific iteration, select {% octicon "kebab-horizontal" aria-label="Open additional options" %}, then click **Compare changes**, **Restore**, or **Download**.
+
+   ![Screenshot of the page for repository rulesets history. A dropdown menu labeled with three dots is expanded and highlighted with an orange outline.](/assets/images/help/repository/ruleset-history-options.png)