Merge branch 'master' into rc/v2.9

Mostly typographical corrections in the code base.

Also the update to the GitHub Actions workflows to avoid problems with forks and self-hosted runners.

Author: mpilgrem

.github/workflows/integration-tests.yml

@@ -95,14 +95,45 @@ jobs:
         name: ${{ runner.os }}
         path: _release/stack-*
 
+  configuration:
+    name: Check for self-hosted runners
+    runs-on: ubuntu-latest
+    env:
+      CAN_SIGN: ${{ secrets.RELEASE_SIGNING_KEY != '' }}
+    outputs:
+      arm64: ${{ steps.runners.outputs.arm64 }}
+      can-sign: ${{ env.CAN_SIGN }}
+    steps:
+    - name: Check for hosted runners
+      id: runners
+      shell: bash
+      env:
+        SELF_HOSTED_RUNNERS: ${{ secrets.SELF_HOSTED_RUNNERS || (github.repository_owner == 'commercialhaskell' && 'arm64') }}
+      run: |
+        echo "::set-output name=runners::$SELF_HOSTED_RUNNERS"
+        if echo "$SELF_HOSTED_RUNNERS" | grep -q 'arm64'; then
+          echo "::set-output name=arm64::['self-hosted', 'linux', 'ARM64']"
+        else
+          echo '::set-output name=arm64::"ubuntu-latest"'
+        fi
+
   linux-arm64:
     name: Linux ARM64
-    runs-on: [self-hosted, linux, ARM64]
+    runs-on: ${{ fromJSON(needs.configuration.outputs.arm64) }}
+    needs: configuration
     steps:
+    - name: Skipping ARM64
+      if: needs.configuration.outputs.arm64 == 'ubuntu-latest'
+      shell: bash
+      run: |
+        echo '::notice title=ARM64 skipped::To build ARM64, a self-hosted runner needs to be configured and the SELF_HOSTED_RUNNERS secret must contain arm64'
+
     - name: Clone project
+      if: needs.configuration.outputs.arm64 != 'ubuntu-latest'
       uses: actions/checkout@v3
 
     - name: Build bindist
+      if: needs.configuration.outputs.arm64 != 'ubuntu-latest'
       shell: bash
       run: |
         set -ex
@@ -112,13 +143,16 @@ jobs:
         docker run --rm -v $(pwd):/src -w /src stack bash -c "/home/stack/release build"
 
     - name: Upload bindist
+      if: needs.configuration.outputs.arm64 != 'ubuntu-latest'
       uses: actions/upload-artifact@v3
       with:
         name: Linux-ARM64
         path: _release/stack-*
 
   github-release:
-    name: Create Github release
+    name: Create GitHub release
+    permissions:
+      contents: write
     needs:
     - integration-tests
     - linux-arm64
@@ -141,11 +175,13 @@ jobs:
         name: Windows
         path: _release
     - name: Download Linux-ARM64 artifact
+      if: contains(needs.configuration.outputs.runners, 'arm64')
       uses: actions/download-artifact@v3
       with:
         name: Linux-ARM64
         path: _release
     - name: Hash and sign assets
+      if: needs.configuration.outputs.can-sign
       shell: bash
       env:
         RELEASE_SIGNING_KEY: ${{ secrets.RELEASE_SIGNING_KEY }}
@@ -157,17 +193,17 @@ jobs:
           shasum -a 256 "$asset" >"$asset.sha256"
           gpg --digest-algo=sha512 --detach-sig --armor -u 0x575159689BEFB442 "$asset"
         done
-    - name: Set Github ref variables
+    - name: Set GitHub ref variables
       id: github_ref_vars
       run: |
         echo ::set-output name=SOURCE_TAG::${GITHUB_REF#refs/tags/}
-    - name: Create Github release (final)
+    - name: Create GitHub release (final)
       if: "!startsWith(github.ref, 'refs/tags/rc/')"
-      uses: actions/create-release@v1
+      uses: ncipollo/release-action@v1.10.0
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       with:
-        tag_name: ${{ github.ref }}
+        tag: ${{ github.ref }}
         body: |
           See https://haskellstack.org/ for installation and upgrade instructions.
 
@@ -180,20 +216,20 @@ jobs:
           [INSERT CONTRIBUTORS]
         draft: true
         prerelease: false
-    - name: Create Github release (release candidate)
+    - name: Create GitHub release (release candidate)
       if: "startsWith(github.ref, 'refs/tags/rc/')"
-      uses: actions/create-release@v1
+      uses: ncipollo/release-action@v1.10.0
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       with:
-        tag_name: ${{ github.ref }}
+        tag: ${{ github.ref }}
         body: |
           **Changes since v[INSERT PREVIOUS VERSION]:**
 
           [INSERT CHANGELOG]
         draft: true
         prerelease: true
-    - name: Upload assets to Github release (final)
+    - name: Upload assets to GitHub release (final)
       if: "!startsWith(github.ref, 'refs/tags/rc/')"
       uses: xresloader/upload-to-github-release@v1
       env:
@@ -204,7 +240,7 @@ jobs:
         draft: true
         prerelease: false
         overwrite: true
-    - name: Upload assets to Github release (release candidate)
+    - name: Upload assets to GitHub release (release candidate)
       if: "startsWith(github.ref, 'refs/tags/rc/')"
       uses: xresloader/upload-to-github-release@v1
       env:

.github/workflows/stan.yml renamed to .github/workflows/stan.yml.disabled

@@ -1,15 +1,16 @@
+# This workflow has been disabled by renaming the file `stan.yml.disabled`
+# because Stan does not yet support GHC >= 9.0.
+# See: https://github.com/kowainik/stan/issues/423.
+#
 name: stan
 
-# Disabled because Stan does not yet support GHC >= 9.0. See:
-# https://github.com/kowainik/stan/issues/423
-
-# on:
-#   pull_request:
-#   push:
-#     branches:
-#     - master
-#     - stable
-#     - rc/**
+on:
+  pull_request:
+  push:
+    branches:
+    - master
+    - stable
+    - rc/**
 
 jobs:
   build:

etc/scripts/get-stack.sh

@@ -69,7 +69,7 @@ post_install_separator() {
   info ""
 }
 
-# determines the the CPU's instruction set
+# determines the CPU's instruction set
 get_isa() {
   if uname -m | grep -Eq 'armv[78]l?' ; then
     echo arm
@@ -301,7 +301,7 @@ do_osx_install() {
   info ""
 }
 
-# # Attempts to insall on FreeBSD.  Installs dependencies with
+# # Attempts to install on FreeBSD.  Installs dependencies with
 # # 'pkg install' and then downloads bindist.
 # do_freebsd_install() {
 #   install_dependencies() {

etc/scripts/mirror-ghc-bindists-to-github.sh

@@ -1,10 +1,10 @@
 #!/usr/bin/env bash
 #
 # This script will download official GHC bindists from download.haskell.org and upload
-# them to the Github Release that Stack uses.
+# them to the GitHub Release that Stack uses.
 #
 # Prerequisites:
-#  - Create a Github release with tag `ghc-X.Y.Z-release`
+#  - Create a GitHub release with tag `ghc-X.Y.Z-release`
 #  - Set GITHUB_AUTH_TOKEN to a token that has permission to upload assets to a Release
 #
 # To use:
@@ -31,7 +31,7 @@ UPLOAD_URL="$(curl --fail -sSLH "Authorization: token $GITHUB_AUTH_TOKEN" https:
 if [[ -z "$UPLOAD_URL" ]]; then
   set +x
   echo
-  echo "$0: Could not get upload URL from Github" >&2
+  echo "$0: Could not get upload URL from GitHub" >&2
   exit 1
 fi
 echo 'ghc:' >stack-setup-$GHCVER.yaml

etc/scripts/release.hs

@@ -67,7 +67,7 @@ main =
                 gArch = arch
                 gBinarySuffix = ""
                 gTestHaddocks = True
-                gProjectRoot = "" -- Set to real value velow.
+                gProjectRoot = "" -- Set to real value below.
                 gBuildArgs = platformArgs <> ["--flag", "stack:-developer-mode"]
                 gStaticLinux = False
                 gCertificateName = Nothing

src/Data/Attoparsec/Combinators.hs

@@ -20,6 +20,6 @@ alternating a b = a <|> b
 pured :: (Applicative g,Applicative f) => g a -> g (f a)
 pured = fmap pure
 
--- | Concatting the result of an action.
+-- | Concating the result of an action.
 concating :: (Monoid m,Applicative f) => f [m] -> f m
 concating = fmap mconcat

src/Data/Monoid/Map.hs

@@ -6,7 +6,7 @@ module Data.Monoid.Map where
 import qualified Data.Map as M
 import           Stack.Prelude
 
--- | Utility newtype wrapper to make make Map's Monoid also use the
+-- | Utility newtype wrapper to make Map's Monoid also use the
 -- element's Monoid.
 newtype MonoidMap k a = MonoidMap (Map k a)
     deriving (Eq, Ord, Read, Show, Generic, Functor)

src/Network/HTTP/StackClient.hs

@@ -41,7 +41,7 @@ module Network.HTTP.StackClient
   , partFileRequestBody
   , partBS
   , partLBS
-  , setGithubHeaders
+  , setGitHubHeaders
   , download
   , redownload
   , verifiedDownload
@@ -113,8 +113,8 @@ withResponse
 withResponse = Network.HTTP.Simple.withResponse . setUserAgent
 
 -- | Set the user-agent request header
-setGithubHeaders :: Request -> Request
-setGithubHeaders = setRequestHeader "Accept" ["application/vnd.github.v3+json"]
+setGitHubHeaders :: Request -> Request
+setGitHubHeaders = setRequestHeader "Accept" ["application/vnd.github.v3+json"]
 
 -- | Download the given URL to the given location. If the file already exists,
 -- no download is performed. Otherwise, creates the parent directory, downloads

src/Path/Extra.hs

@@ -8,7 +8,7 @@ module Path.Extra
   ,dropRoot
   ,parseCollapsedAbsDir
   ,parseCollapsedAbsFile
-  ,concatAndColapseAbsDir
+  ,concatAndCollapseAbsDir
   ,rejectMissingFile
   ,rejectMissingDir
   ,pathToByteString
@@ -48,8 +48,8 @@ parseCollapsedAbsFile = parseAbsFile . collapseFilePath
 -- | Add a relative FilePath to the end of a Path
 -- We can't parse the FilePath first because we need to account for ".."
 -- in the FilePath (#2895)
-concatAndColapseAbsDir :: MonadThrow m => Path Abs Dir -> FilePath -> m (Path Abs Dir)
-concatAndColapseAbsDir base rel = parseCollapsedAbsDir (toFilePath base FP.</> rel)
+concatAndCollapseAbsDir :: MonadThrow m => Path Abs Dir -> FilePath -> m (Path Abs Dir)
+concatAndCollapseAbsDir base rel = parseCollapsedAbsDir (toFilePath base FP.</> rel)
 
 -- | Collapse intermediate "." and ".." directories from a path.
 --
@@ -84,7 +84,7 @@ dropRoot (Path l) = Path (FP.dropDrive l)
 -- is to be used in conjunction with 'forgivingAbsence' and
 -- 'resolveFile'.
 --
--- Previously the idiom @forgivingAbsence (relsoveFile …)@ alone was used,
+-- Previously the idiom @forgivingAbsence (resolveFile …)@ alone was used,
 -- which relied on 'canonicalizePath' throwing 'isDoesNotExistError' when
 -- path does not exist. As it turns out, this behavior is actually not
 -- intentional and unreliable, see

src/Stack/Build/ConstructPlan.hs

@@ -481,7 +481,7 @@ tellExecutables _name (PSFilePath lp)
     | otherwise = return ()
 -- Ignores ghcOptions because they don't matter for enumerating
 -- executables.
-tellExecutables name (PSRemote pkgloc _version _fromSnaphot cp) =
+tellExecutables name (PSRemote pkgloc _version _fromSnapshot cp) =
     tellExecutablesUpstream name (pure $ Just pkgloc) Snap (cpFlags cp)
 
 tellExecutablesUpstream ::
@@ -529,7 +529,7 @@ installPackage :: PackageName
 installPackage name ps minstalled = do
     ctx <- ask
     case ps of
-        PSRemote pkgLoc _version _fromSnaphot cp -> do
+        PSRemote pkgLoc _version _fromSnapshot cp -> do
             planDebug $ "installPackage: Doing all-in-one build for upstream package " ++ show name
             package <- loadPackage ctx pkgLoc (cpFlags cp) (cpGhcOptions cp) (cpCabalConfigOpts cp)
             resolveDepsAndInstall True (cpHaddocks cp) ps package minstalled
@@ -645,7 +645,7 @@ installPackageGivenDeps isAllInOne buildHaddocks ps package minstalled (missing,
                 case ps of
                     PSFilePath lp ->
                       TTLocalMutable lp
-                    PSRemote pkgLoc _version _fromSnaphot _cp ->
+                    PSRemote pkgLoc _version _fromSnapshot _cp ->
                       TTRemotePackage mutable package pkgLoc
             , taskAllInOne = isAllInOne
             , taskCachePkgSrc = toCachePkgSrc ps