provide GitHub Action

Author: sebthom

.github/workflows/build.yml

@@ -45,6 +45,7 @@ jobs:
       fail-fast: false
       matrix:
         os:
+        - ubuntu-latest
         - ubuntu-22.04
         - ubuntu-20.04
         - windows-latest
@@ -53,18 +54,24 @@ jobs:
     - name: Git Checkout
       uses: actions/checkout@v3 #https://github.com/actions/checkout
 
+    - name: "Linux: Configure APT"
+      uses: ./
+      with:
+        repo-name:   ${{ github.repository }}
+        repo-branch: ${{ github.ref_name }}
+
     - name: Run shellcheck
       run: bash tests/run-shellcheck.sh
 
     - name: Install bashcov
-      if: ${{ runner.os == 'Linux' }}
+      if: ${{ runner.os == 'Linux' && !env.ACT }}
       run: sudo gem install bashcov simplecov-console
 
     - name: Run tests
       timeout-minutes: 5
       run: |
         set -eu
-        if [[ "${{ runner.os }}" == "Linux" ]]; then
+        if [[ "${{ runner.os }}" == "Linux" && "${{ env.ACT }}" != "true" ]]; then
           bashcov --skip-uncovered tests/run-tests.sh
         else
           bash tests/run-tests.sh

README.md

@@ -9,8 +9,9 @@
 **Feedback and high-quality pull requests are highly welcome!**
 
 1. [What is it?](#what-is-it)
-1. [Installation](#installation)
-1. [Usage](#usage)
+1. [Usage as GitHub Action](#github_action)
+1. [Usage on the commandline](#cli)
+   1. [Installation](#installation)
    1. [`current` command](#current-command)
    1. [`find` command](#find-command)
    1. [`set` command](#set-command)
@@ -24,10 +25,31 @@
 on [Debian](https://www.debian.org/), [Ubuntu](https://ubuntu.com/), [Pop!_OS](https://pop.system76.com/) systems.
 
 It was born out of the ongoing stability [issues](https://github.com/actions/runner-images/issues?q=is%3Aissue+azure.archive.ubuntu.com) with the `azure.archive.ubuntu.com` Ubuntu
-mirror pre-configured in Github Actions runners.
+mirror pre-configured in GitHub Actions runners.
+
+
+## <a name="github_action"></a>Usage as GitHub Action
+
+```yaml
+name: Build
+on: [ push, pull_request ]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Configure Fast APT Mirror
+      uses: vegardit/fast-apt-mirror.sh@v1
+      with: # the following parameters are listed with their action default values and are optional
+        healthchecks:  20 # Number of mirrors from the mirrors list to check for availability and up-to-dateness
+        speedtests:    10 # Maximum number of healthy mirrors to test for speed
+        parallel:       2 # Number of parallel speed tests
+        sample-size: 1024 # Number of kilobytes to download during the speed from each mirror
+        sample-time:    3 # Maximum number of seconds within the sample download from a mirror must finish
+```
 
+## <a name="cli"></a>Usage on the command line
 
-## <a name="installation"></a>Installation
+### <a name="installation"></a>Installation
 
 For example:
 ```bash
@@ -37,13 +59,9 @@ $ sudo apt-get install -y bash curl apt-transport-https ca-certificates
 # install fast-apt-mirror.sh under /usr/local/bin/ to make it automatically available via $PATH
 $ sudo curl https://raw.githubusercontent.com/vegardit/fast-apt-mirror.sh/v1/fast-apt-mirror.sh -o /usr/local/bin/fast-apt-mirror.sh
 $ sudo chmod 755 /usr/local/bin/fast-apt-mirror.sh
-```
-
-
-## <a name="usage"></a>Usage
 
-Available sub commands:
-```yml
+# show the help
+$ fast-apt-mirror.sh --help
 fast-apt-mirror.sh COMMAND
 
 Available commands:
@@ -78,11 +96,11 @@ Usage:
 fast-apt-mirror.sh find [OPTION]...
 
 Options:
-     --apply            - Replaces the current APT mirror in /etc/apt/sources.list with a fast mirror and runs 'sudo apt-get update'
+     --apply            - Replaces the current APT mirror in /etc/apt/(sources.list|sources.list.d/system.sources) with a fast mirror and runs 'sudo apt-get update'
      --exclude-current  - If specified, don't include the current APT mirror in the speed tests.
- -p, --parallel N       - Number of parallel speed tests. May result in incorrect results because of competing connections but finds a suitable mirror faster.
-     --healthchecks N   - Number of mirrors from the Ubuntu/Debian mirror lists to check for availability and up-to-dateness - default is 20
+     --healthchecks N   - Number of mirrors from the mirrors list to check for availability and up-to-dateness - default is 20
      --speedtests N     - Maximum number of healthy mirrors to test for speed - default is 5
+ -p, --parallel N       - Number of parallel speed tests. May result in incorrect results because of competing connections but finds a suitable mirror faster.
      --sample-size KB   - Number of kilobytes to download during the speed from each mirror - default is 200KB
      --sample-time SECS - Maximum number of seconds within the sample download from a mirror must finish - default is 3
  -v, --verbose          - More output. Specify multiple times to increase verbosity.

action.yml

@@ -0,0 +1,53 @@
+# SPDX-FileCopyrightText: © Vegard IT GmbH (https://vegardit.com) and contributors
+# SPDX-FileContributor: Sebastian Thomschke, Vegard IT GmbH
+# SPDX-License-Identifier: Apache-2.0
+#
+# https://docs.github.com/en/actions/creating-actions/creating-a-composite-action
+name: Configure fast APT mirror
+description: Configures a fast APT mirror in Ubuntu runners, e.g. in case azure.archive.ubuntu.com is slow or unreachable.
+author: Vegard IT GmbH (https://vegardit.com)
+branding:
+  color: blue
+  icon: settings
+
+inputs:
+  healthchecks: { default:   "20", description: "Number of mirrors from the mirrors list to check for availability and up-to-dateness." }
+  speedtests:   { default:   "10", description: "Maximum number of healthy mirrors to test for speed." }
+  parallel:     { default:    "2", description: "Number of parallel speed tests. May result in incorrect results because of competing connections but finds a suitable mirror faster." }
+  sample-size:  { default: "1024", description: "Number of kilobytes to download during the speed from each mirror." }
+  sample-time:  { default:    "3", description: "Maximum number of seconds within the sample download from a mirror must finish." }
+  
+  repo-name:   { default: "vegardit/fast-apt-mirror.sh", description: "Repository containing the fast-apt-mirror.sh script" }
+  repo-branch: { default: "v1", description: "Version (i.e. github branch) of the fast-apt-mirror.sh script to use" }
+
+runs:
+  using: "composite"
+  steps:
+    - name: "Linux: Configure fast APT mirror"
+      if: runner.os == 'Linux'
+      shell: bash
+      run: |
+        echo "::group::Linux: Configure fast APT mirror"
+        set -euo pipefail
+
+        echo 'APT::Acquire::Retries "3";' | sudo tee /etc/apt/apt.conf.d/80-acquire-retries
+
+        if [[ "${{ env.ACT }}" != "true" ]]; then
+          # Workaround to avoid sporadic connectivity issues "Could not connect to azure.archive.ubuntu.com:80"
+          # see https://github.com/actions/runner-images/issues/675
+          # see https://github.com/actions/runner-images/issues/704
+          curl -sSfL https://raw.githubusercontent.com/${{ inputs.repo-name }}/${{ inputs.repo-branch }}/fast-apt-mirror.sh -o $HOME/fast-apt-mirror.sh
+          bash $HOME/fast-apt-mirror.sh find --apply -v \
+            --healthchecks ${{ inputs.healthchecks }} \
+            --speedtests   ${{ inputs.speedtests }} \
+            --parallel     ${{ inputs.parallel }} \
+            --sample-size  ${{ inputs.sample-size }} \
+            --sample-time  ${{ inputs.sample-time }}
+        fi
+
+        # refresh pkg cache if it does not exist or is older than 60min.
+        # avoid potential 404 see https://github.com/actions/runner-images/issues/592
+        if [[ ! -e /var/lib/apt/lists/partial ]] || [[ $(( $(date +%s) - $(sudo date +%s -r /var/lib/apt/lists/partial) )) -gt 3600 ]]; then
+          sudo apt-get update
+        fi
+        echo "::endgroup::"

fast-apt-mirror.sh

@@ -196,9 +196,9 @@ function find_fast_mirror() {
         echo "Options:"
         echo "     --apply            - Replaces the current APT mirror in /etc/apt/(sources.list|sources.list.d/system.sources) with a fast mirror and runs 'sudo apt-get update'"
         echo "     --exclude-current  - If specified, don't include the current APT mirror in the speed tests."
-        echo " -p, --parallel N       - Number of parallel speed tests. May result in incorrect results because of competing connections but finds a suitable mirror faster."
         echo "     --healthchecks N   - Number of mirrors from the mirrors list to check for availability and up-to-dateness - default is 20"
         echo "     --speedtests N     - Maximum number of healthy mirrors to test for speed - default is 5"
+        echo " -p, --parallel N       - Number of parallel speed tests. May result in incorrect results because of competing connections but finds a suitable mirror faster."
         echo "     --sample-size KB   - Number of kilobytes to download during the speed from each mirror - default is 200KB"
         echo "     --sample-time SECS - Maximum number of seconds within the sample download from a mirror must finish - default is 3"
         echo " -v, --verbose          - More output. Specify multiple times to increase verbosity."