Merge branch 'master' into spelling

Author: djdefi

.github/dependabot.yml

@@ -0,0 +1,16 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "docker" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"
+      
+  - package-ecosystem: "github-actions" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"

.github/workflows/docker-image.yml

@@ -0,0 +1,25 @@
+name: Docker Image CI
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+jobs:
+
+  build-docker:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Build the Debian Docker image
+      run: docker build . --file Dockerfile --tag backup-utils-debian:${GITHUB_RUN_ID}
+    - name: Build the Alpine Docker image
+      run: docker build . --file Dockerfile.alpine --tag backup-utils-alpine:${GITHUB_RUN_ID}
+    - name: Run tests in Debian Docker image
+      run: docker run backup-utils-debian:${GITHUB_RUN_ID} ghe-backup --version
+    - name: Run tests in Alpine Docker image
+      run: docker run backup-utils-alpine:${GITHUB_RUN_ID} ghe-backup --version
+      

.github/workflows/lint.yml

@@ -1,18 +1,23 @@
 name: Lint Code Base
 
 on:
+  push:
+    branches-ignore: [master]
   pull_request:
-    branches-ignore:
-      - 'master'
+    branches: [master]
 
 jobs:
-  build:
+  lint:
     name: Lint Code Base
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
+        with:
+          # Full git history is needed to get a proper list of changed files within `super-linter`
+          fetch-depth: 0
       - name: Lint Code Base
-        uses: docker://github/super-linter:v2.1.1
+        uses: github/super-linter@v4
         env:
           VALIDATE_ALL_CODEBASE: false
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/main.yml

@@ -6,7 +6,7 @@ jobs:
   build:
     strategy:
       matrix:
-        os: ['ubuntu-20.04', 'ubuntu-18.04', 'macos-latest']
+        os: ['ubuntu-22.04', 'ubuntu-20.04', 'ubuntu-18.04', 'macos-latest']
       fail-fast: false
     runs-on: ${{ matrix.os }}
     steps:
@@ -20,11 +20,11 @@ jobs:
       if: matrix.os != 'macos-latest'
     - name: Install Dependencies (macOS)
       run: |
-        brew install gnu-tar shellcheck jq pigz coreutils gnu-sed gnu-getopt
+        brew install gnu-tar shellcheck jq pigz coreutils gnu-sed gnu-getopt wget
         brew install moreutils gawk
       if: matrix.os == 'macos-latest'
     - name: Get Sources
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
     - name: Test
       run: |
         export PATH="$PATH:/snap/bin"

Dockerfile

@@ -1,4 +1,4 @@
-FROM debian:stretch-slim
+FROM debian:buster-slim
 
 RUN apt-get -q -y update && \
     apt-get install -y --no-install-recommends \

README.md

@@ -3,33 +3,33 @@
 This repository includes backup and recovery utilities for
 [GitHub Enterprise Server][1].
 
-**UPDATE**: The new parallel backup and restore beta feature will require [GNU awk](https://www.gnu.org/software/gawk) and [moreutils](https://joeyh.name/code/moreutils) to be installed. Note that on some distributions/platforms, the `moreutils-parallel` package is separate from `moreutils` and must be installed on its own.
+**Note**: The parallel backup and restore feature will require [GNU awk](https://www.gnu.org/software/gawk) and [moreutils](https://joeyh.name/code/moreutils) to be installed. Note that on some distributions/platforms, the `moreutils-parallel` package is separate from `moreutils` and must be installed on its own.
 
 **Note**: the [GitHub Enterprise Server version requirements][2] have
 changed starting with Backup Utilities v2.13.0, released on 27 March 2018.
 
-### Features
+## Features
 
 Backup Utilities implement a number of advanced capabilities for backup
 hosts, built on top of the backup and restore features already included in
 GitHub Enterprise Server.
 
- - Complete GitHub Enterprise Server backup and recovery system via two simple
+- Complete GitHub Enterprise Server backup and recovery system via two simple
    utilities:<br>`ghe-backup` and `ghe-restore`.
- - Online backups. The GitHub appliance need not be put in maintenance mode for
+- Online backups. The GitHub appliance need not be put in maintenance mode for
    the duration of the backup run.
- - Incremental backup of Git repository data. Only changes since the last
+- Incremental backup of Git repository data. Only changes since the last
    snapshot are transferred, leading to faster backup runs and lower network
    bandwidth and machine utilization.
- - Efficient snapshot storage. Only data added since the previous snapshot
+- Efficient snapshot storage. Only data added since the previous snapshot
    consumes new space on the backup host.
- - Multiple backup snapshots with configurable retention periods.
- - Backup commands run under the lowest CPU/IO priority on the GitHub appliance,
+- Multiple backup snapshots with configurable retention periods.
+- Backup commands run under the lowest CPU/IO priority on the GitHub appliance,
    reducing performance impact while backups are in progress.
- - Runs under most Linux/Unix environments.
- - MIT licensed, open source software maintained by GitHub, Inc.
+- Runs under most Linux/Unix environments.
+- MIT licensed, open source software maintained by GitHub, Inc.
 
-### Documentation
+## Documentation
 
 - **[Requirements](docs/requirements.md)**
   - **[Backup host requirements](docs/requirements.md#backup-host-requirements)**
@@ -42,7 +42,7 @@ GitHub Enterprise Server.
 - **[How does Backup Utilities differ from a High Availability replica?](docs/faq.md)**
 - **[Docker](docs/docker.md)**
 
-### Support
+## Support
 
 If you find a bug or would like to request a feature in Backup Utilities, please
 open an issue or pull request on this repository. If you have a question related
@@ -53,3 +53,4 @@ instead.
 [1]: https://github.com/enterprise
 [2]: docs/requirements.md#github-enterprise-version-requirements
 [3]: https://support.github.com/
+

backup.config-example

@@ -64,27 +64,23 @@ GHE_NUM_SNAPSHOTS=10
 
 # If set to 'yes', ghe-backup jobs will run in parallel. Defaults to 'no'.
 #
-# WARNING: this feature is in beta.
 #GHE_PARALLEL_ENABLED=yes
 
 # Sets the maximum number of jobs to run in parallel. Defaults to the number
 # of available processing units on the machine.
 #
-# WARNING: this feature is in beta.
 #GHE_PARALLEL_MAX_JOBS=2
 
 # Sets the maximum number of rsync jobs to run in parallel. Defaults to the
 # configured GHE_PARALLEL_MAX_JOBS, or the number of available processing 
 # units on the machine.
 #
-# WARNING: this feature is in beta.
 # GHE_PARALLEL_RSYNC_MAX_JOBS=3
 
 # When jobs are running in parallel wait as needed to avoid starting new jobs
 # when the system's load average is not below the specified percentage. Defaults to
 # unrestricted.
 #
-# WARNING: this feature is in beta.
 #GHE_PARALLEL_MAX_LOAD=50
 
 # When running an external mysql database, run this script to trigger a MySQL backup

bin/ghe-host-check

@@ -131,7 +131,7 @@ fi
 
 # backup-utils 2.13 onwards limits support to the current and previous two releases
 # of GitHub Enterprise Server.
-supported_minimum_version="3.3.0"
+supported_minimum_version="3.5.0"
 
 if [ "$(version $version)" -ge "$(version $supported_minimum_version)" ]; then
   supported=1

bin/ghe-restore

@@ -104,7 +104,7 @@ cleanup () {
     update_restore_status "$1"
   fi
 
-  if ghe-ssh "$GHE_HOSTNAME" -- 'ghe-config --true app.actions.enabled'; then
+  if $ACTIONS_STOPPED && ghe-ssh "$GHE_HOSTNAME" -- 'ghe-config --true app.actions.enabled'; then
     echo "Restarting Actions after restore ..."
     # In GHES 3.3+, ghe-actions-start no longer has a -f (force) flag. In GHES 3.2 and below, we must provide the
     # force flag to make sure it can start in maintenance mode. Use it conditionally based on whether it exists
@@ -161,6 +161,9 @@ hostname=$(echo "$GHE_HOSTNAME" | cut -f 1 -d :)
 # Show usage with no <host>
 [ -z "$GHE_HOSTNAME" ] && print_usage
 
+# Flag to indicate if this script has stopped Actions.
+ACTIONS_STOPPED=false
+
 # ghe-restore-snapshot-path validates it exists, determines what current is,
 # and if there's any problem, exit for us
 GHE_RESTORE_SNAPSHOT_PATH="$(ghe-restore-snapshot-path "$snapshot_id")"
@@ -282,6 +285,14 @@ fi
 # Get GHES release version in major.minor format
 RELEASE_VERSION=$(ghe-ssh "$GHE_HOSTNAME" -- 'ghe-config --get core.package-version' | cut -d '.' -f 1,2)
 
+# If the backup being restored is from an appliance with Actions disabled, restoring it onto an appliance with Actions enabled will cause
+# mismatches in the secrets needed for Actions which ultimately results in Actions not working properly. Note: xargs is to remove whitespace
+ACTIONS_ENABLED_IN_BACKUP=$(git config -f $GHE_RESTORE_SNAPSHOT_PATH/settings.json --bool app.actions.enabled | xargs)
+if [[ $ACTIONS_ENABLED_IN_BACKUP != true ]] && ghe-ssh "$GHE_HOSTNAME" -- 'ghe-config --true app.actions.enabled'; then
+    echo "Error: Restoring a backup with Actions disabled onto an appliance with Actions enabled is not supported." >&2
+    exit 1
+fi
+
 # Make sure the GitHub appliance has Actions enabled if the snapshot contains Actions data.
 # If above is true, also check if ac is present in appliance then snapshot should also contains ac databases
 if [ -d "$GHE_RESTORE_SNAPSHOT_PATH/mssql" ] || [ -d "$GHE_RESTORE_SNAPSHOT_PATH/actions" ]; then
@@ -399,6 +410,9 @@ fi
 
 if ghe-ssh "$GHE_HOSTNAME" -- 'ghe-config --true app.actions.enabled'; then
   echo "Stopping Actions before restoring databases ..."
+  # We mark Actions as stopped even if the `ghe-actions-stop`
+  # fails to ensure that we cleanly start actions when performing cleanup.
+  ACTIONS_STOPPED=true
   ghe-ssh "$GHE_HOSTNAME" -- 'ghe-actions-stop' 1>&3
 
   echo "Restoring MSSQL databases ..."

debian/changelog

@@ -1,3 +1,13 @@
+github-backup-utils (3.7.0) UNRELEASED; urgency=medium
+
+
+ -- Devin Dooley <[email protected]>  Tue, 25 Oct 2022 00:35:38 +0000
+
+github-backup-utils (3.6.0) UNRELEASED; urgency=medium
+
+
+ -- Joe Franks <[email protected]>  Wed, 17 Aug 2022 19:20:54 +0000
+
 github-backup-utils (3.5.0) UNRELEASED; urgency=medium
 
   * Simplify complex redirects for ghe-rsync #881