In this article, you will get information about all protected resources, elements and metadata in GitHub Enterprise.
GitHub protected resources define which repositories and data Xopero ONE can access, secure, and restore.
Protected data
Support for backing up projects (classic) has been removed. It is now available only for restoring previously backed-up projects (classic) — when restored, projects (classic) are automatically converted into projects v2.
Protected metadata for projects (classic) include cards, issues assigned to cards, pull requests assigned to cards, columns, and notes.
ACTIONS AND PIPELINES
BRANCH PROTECTION RULES
COLLABORATORS
DEPENDABOT
ISSUES
LABELS
MILESTONES
PROJECTS (V2)
PULL REQUESTS
REPOSITORY
TEAMS
Description
Members
Members Roles
RELEASES
Assets
Description
Releases
Branch Name Pattern
Lock Branch
Require a Pull Request Before Merging
Require Conversation Resolution Before Merging
Require Linear History
Require Signed Commits
Require Status Checks to Pass Before Merging
Roles
Creator
Issue Assets
Issue Comments
Issue Description
Labels Assigned
Milestones Assigned
Open Issues
Projects Assigned
Description
Name
Closed Milestones
Description
Due Date
Open Milestones
Title
Custom Number Column
Custom Single Select Column
Custom Text Column
Description
Draft Issues in Project
Issues in Project
Labels Column
Linked Pull Requests Column
Milestone Column
Pull Requests in Project
Readme
Repository Column
Reviewers Column
State
Status Column
Status Updates
Comments
Commits
Creation Date
Creator
Description
Labels
Merged Pull Requests
Milestones
Open Pull Requests
Commit Comments
Commit Creator
Commit Message
Commit Text
General Settings
Allow Merge Commits
Allow Rebase Merging
Allow Squash Merging
Automatically Delete Head Branches
Default Branch
Default Merge Commits Message
Default Squash Merging Message
Template Repository
Homepage
LFS
Logs
Objects
Refs
Repository
Repository Description
Repository Name
Settings
Deploy Keys
Tags
Webhooks
Wiki
Name
Parent Team
Permissions to Repository
Team Notifications
Visibility
Set as a Pre-release
Set as the Latest Release
Tags
Creating a backup plan
This article describes how to create a backup plan to back up your GitHub Enterprise repositories.
Backup plan setup
1
Login to XMS, open the Plans > Backup tab and click the Add plan button in the top bar.
2
Select GitHub from the list.
3
Select (or add) the GitHub Enterprise environment you want to include in the backup process, and choose the repositories to back up.
4
Specify a name for the backup plan.
5
Select the appropriate metadata that you want to back up. Here, you can also change the default worker, which is the device directly responsible for the backup process of your repositories.
6
Select one of the locations assigned to your Xopero ONE instance as storage.
7
Customize the scheduler and specify how long your data should be retained. If needed, adjust the advanced settings to suit your needs.
8
If necessary, adjust the advanced settings such as encryption, error handling, or bandwidth limits to fit your requirements.
9
Double-check your data and click Save to create the backup plan.
In Xopero ONE, you can select repositories based on custom properties, but these properties must be configured at the organization level in GitHub. During synchronization, Xopero ONE retrieves the property definitions from the organization and the assigned values from the repositories. After synchronization, the panel displays a list of all properties fetched from every organization on the GitHub side that was added to XMS. For the feature to work correctly, the token used for authorization must also include the read:org permission.
Optionally, Xopero ONE allows you to protect the entire GitHub Enterprise environment.
You can have multiple workers and assign different workers to each backup plan.
It is worth noting that the cloud worker (a cloud-installed Xopero ONE worker) allows you to perform cloud-to-cloud backups if you want to store your backups in the cloud.