Skip to content

Commit

Permalink
Fixing linting errors
Browse files Browse the repository at this point in the history
  • Loading branch information
davidjarzebowski authored Nov 30, 2023
1 parent d68e166 commit 687b178
Showing 1 changed file with 27 additions and 12 deletions.
39 changes: 27 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,29 +50,44 @@ backup site setup or recovery, or would like to report a bug or a feature reques

## Repository updates - November 2023

In October 2023 we announced a number of changes to this repository. These changes will improve our (GitHub’s) ability to ship enhancements and new features to backup-utils, as well as simplify how GitHub Enterprise Server customers interact with backup-utils.
In October 2023 we announced a number of changes to this repository.
These changes will improve our (GitHub’s) ability to ship enhancements and new features to backup-utils,
as well as simplify how GitHub Enterprise Server customers interact with backup-utils.

Our process for shipping new versions of backup-utils prior to November 2023 involved a 2-way sync between this repository and an internal repository. This 2-way sync became significantly more problematic once we started regularly shipping patches in alignment with GitHub Enterprise Server.
Our process for shipping new versions of backup-utils prior to November 2023 involved a 2-way sync between this repository and an internal repository.
This 2-way sync became significantly more problematic once we started regularly shipping patches in alignment with GitHub Enterprise Server.

As of 2023-11-30 we have stopped this 2-way sync so that our internal repository becomes the source of truth for the backup-utils source code. With the the 2-way sync stopped, this public repository will be used to host documentation about backup-utils and to publish new versions of backup-utils. You will be able to access a specific version of backup-utils (which includes the full source code) from the [release page](https://github.com/github/backup-utils/releases) of this repository.
As of 2023-11-30 we have stopped this 2-way sync so that our internal repository becomes the source of truth for the backup-utils source code.
With the the 2-way sync stopped, this public repository will be used to host documentation about backup-utils and to publish new versions of backup-utils.
You will be able to access a specific version of backup-utils (which includes the full source code) from the [release page](https://github.com/github/backup-utils/releases) of this repository.

This change has not affected the functionality of the backup-utils tool or a customer’s ability to backup or restore their GitHub Enterprise Server instance.

### Details

There are three specific areas that have been affected by us stop the 2-way sync between our internal repository and this public repository on 2023-11-30:

1. **Pull requests**: Customers should no longer open pull requests in this repository. These pull requests will not be reviewed or merged. This is necessary because we will no longer be syncing changes between this repository and our internal repository.
2. **Issues**: Customers cannot open issues in this repository. Instead, customers will need to follow the standard support process and open a support ticket for any questions/concerns/problems with backup-utils. This will ensure all customer requests are handled consistently.
3. **Installing/upgrading backup-utils**: Customers will not be able to use a clone of the repository to install and upgrade backup-utils. Customers will need to download a specific version of backup-utils from the [release page](https://github.com/github/backup-utils/releases) (either as a Debian package or as an archive file - see below for details on how to incorporate this change).
1. **Pull requests**: Customers should no longer open pull requests in this repository.
These pull requests will not be reviewed or merged.
This is necessary because we will no longer be syncing changes between this repository and our internal repository.
2. **Issues**: Customers cannot open issues in this repository.
Instead, customers will need to follow the standard support process and open a support ticket for any questions/concerns/problems with backup-utils.
This will ensure all customer requests are handled consistently.
3. **Installing/upgrading backup-utils**: Customers will not be able to use a clone of the repository to install and upgrade backup-utils.
Customers will need to download a specific version of backup-utils from the [release page](https://github.com/github/backup-utils/releases)
(either as a Debian package or as an archive file - see below for details on how to incorporate this change).

### Timeline

Below is the two phase timeline we will follow to roll out the changes described above:

* **Phase 1 (rolled out on 2023-11-30):** We have closed all open pull requests and issues (after reviewing each one and porting them to our internal repository if merited), and updated the repository settings so that new issues cannot be opened. Also, we have stop syncing code from our internal repository to this repository.
* As of 2023-11-30, you can still get a working copy of backup-utils by cloning the repository. But the code will not be updated in the repository; you can access updated versions of backup-utils via the [release page](https://github.com/github/backup-utils/releases).
* **Phase 2 (rolling out 2024-02-20):** The backup-utils code will be removed and the repository will be used to host documentation for backup-utils. After this date, you will no longer be able to clone a working copy of backup-utils from the repository. Instead, you will need to download a specific version of backup-utils from the [release page](https://github.com/github/backup-utils/releases).
* **Phase 1 (rolled out on 2023-11-30):** We have closed all open pull requests and issues (after reviewing each one and porting them to our internal repository if merited),
and updated the repository settings so that new issues cannot be opened. Also, we have stop syncing code from our internal repository to this repository.
* As of 2023-11-30, you can still get a working copy of backup-utils by cloning the repository.
But the code will not be updated in the repository; you can access updated versions of backup-utils via the [release page](https://github.com/github/backup-utils/releases).
* **Phase 2 (rolling out 2024-02-20):** The backup-utils code will be removed and the repository will be used to host documentation for backup-utils.
After this date, you will no longer be able to clone a working copy of backup-utils from the repository.
Instead, you will need to download a specific version of backup-utils from the [release page](https://github.com/github/backup-utils/releases).

### Updating your backup-utils upgrade process

Expand All @@ -82,12 +97,12 @@ If your current process for upgrading backup-utils involves a clone of the repos

For example, you could download the v3.10.0 (github-backup-utils-v3.10.0.tar.gz) artifact from the [releases page](https://github.com/github/backup-utils/releases/tag/v3.10.0) with:

```
```shell
$ wget https://github.com/github/backup-utils/releases/download/v3.10.0/github-backup-utils-v3.10.0.tar.gz
```
And then extract it:

```
```shell
$ tar xzvf github-backup-utils-v3.10.0.tar.gz
```

Expand All @@ -97,7 +112,7 @@ This will give you a new folder, `github-backup-utils-v3.10.0`, which contains t

For customers that currently use Docker to create a backup-utils image, their existing process may need updating as a result of this change. Previously customers could execute this command to build a Docker image of backup-utils:

```
```shell
$ docker build github.com/github/backup-utils
```

Expand Down

0 comments on commit 687b178

Please sign in to comment.