Prepare 1.6.0 release (#2642)

* Add list of merged prs

* Remove branch trigger

* Update release instructions

* Include 9.2.1 in the current release

* Bump up hls version

* remove duplicate mention

* Remove references to branch name

* Fix cabal.project gen

* Correct fail-fast condition

* Bump up minor version

* Bump up major version

* Bump up major version

* Allow brittany only for 9.0.1

* brittany not supported in hackage and 9.0.2

* Not short hls for hackage

* Bump up versions everywhere

* Update hackage index

* Add ghcide in rename plugin

* Apply linter and add selection demo

* Add header linkable

* Add first version of release description

* Add last prs

* Mention wingman

* Grammar corrections

Co-authored-by: Jan Hrcek <[email protected]>

* Correct mention

Co-authored-by: Pepe Iborra <[email protected]>

* Warn about th in docs

* Remove reference to install doc

* Rephrasing

Co-authored-by: J. S. <[email protected]>

* Better style

Co-authored-by: Junyoung "Clare" Jang <[email protected]>

* Use could to stress it likely will not work

* REmove reliable from the warning

* Reorder comments

* Rephrasing

Co-authored-by: Michael Peyton Jones <[email protected]>

* Update docs/supported-versions.md

Co-authored-by: Michael Peyton Jones <[email protected]>

* Use last version of internal deps

* Restore original wording

* One more pr

* One more pr

Co-authored-by: Jan Hrcek <[email protected]>
Co-authored-by: Pepe Iborra <[email protected]>
Co-authored-by: J. S. <[email protected]>
Co-authored-by: Junyoung "Clare" Jang <[email protected]>
Co-authored-by: Michael Peyton Jones <[email protected]>

Author: 6 people

.github/actions/setup-build/action.yml

@@ -15,6 +15,11 @@ inputs:
     description: "To allow make unique the cache key"
     required: false
     default: ""
+  shorten-hls:
+    description: "Whether we have to shorten haskell language server to hls"
+    required: false
+    default: "true"
+
 runs:
   using: "composite"
   steps:
@@ -47,7 +52,7 @@ runs:
         # File has some protections preventing regular `rm`.
         # (most probably sticky bit is set on $HOME)
         # `&&` insures `rm -f` return is positive.
-        # Many platforms aslo have `alias cp='cp -i'`.
+        # Many platforms also have `alias cp='cp -i'`.
         GHCVER2=${GHCVER//./}
         ALT_PROJECT_FILE_MINOR=cabal-ghc${GHCVER2}.project
         ALT_PROJECT_FILE_MAJOR=cabal-ghc${GHCVER2:0:2}.project
@@ -65,10 +70,11 @@ runs:
       shell: bash
 
     # Shorten binary names as a workaround for filepath length limits in Windows,
-    # but since tests are hardcoded on this workaround -
-    # all platforms (in 2021-12-07) need it.
-    # All workflows which distinquishes cache on `cabal.project` needs this.
-    - name: Workaround shorten binary names
+    # but since tests are hardcoded on this workaround all platforms need it.
+    # All workflows which distinguishes cache on `cabal.project` needs this.
+    # Except hackage one, which needs the original name
+    - if: inputs.shorten-hls == 'true'
+      name: Workaround shorten binary names
       run: |
         sed -i.bak -e 's/haskell-language-server/hls/g' \
                     -e 's/haskell_language_server/hls/g' \

.github/workflows/build.yml

@@ -9,9 +9,6 @@ on:
         default: 'false'
   release:
     types: [created]
-  push:
-    branches:
-      - '*-check-build'
 
 jobs:
   build:
@@ -90,7 +87,7 @@ jobs:
         fi
 
     - name: Upload server to release
-      if: ${{ !contains(github.ref_name, 'check') && github.event.release.upload_url != ''}}
+      if: ${{ github.event.release.upload_url != ''}}
       uses: actions/[email protected]
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -130,7 +127,7 @@ jobs:
         fi
 
     - name: Upload wrapper to the release
-      if: ${{ matrix.ghc == '8.10.7' && !contains(github.ref_name, 'check') && github.event.release.upload_url != '' }}
+      if: ${{ matrix.ghc == '8.10.7' && github.event.release.upload_url != '' }}
       uses: actions/[email protected]
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -173,7 +170,7 @@ jobs:
                       HEAD
 
       - name: Upload source tarball to the release
-        if: ${{ !contains(github.ref_name, 'check') && github.event.release.upload_url != '' }}
+        if: ${{ github.event.release.upload_url != '' }}
         uses: actions/[email protected]
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -220,7 +217,7 @@ jobs:
           tar -czpf haskell-language-server.tar.gz *
 
       - name: Upload binaries tarball to the release
-        if: ${{ !contains(github.ref_name, 'check')  && github.event.release.upload_url != '' }}
+        if: ${{ github.event.release.upload_url != '' }}
         uses: actions/[email protected]
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -258,7 +255,7 @@ jobs:
           sed -i 's/\/.*)/)/g' SHA256SUMS
 
       - name: Upload sha256sums to the release
-        if: ${{ !contains(github.ref_name, 'check')  && github.event.release.upload_url != '' }}
+        if: ${{ github.event.release.upload_url != '' }}
         uses: actions/[email protected]
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/hackage.yml

@@ -20,7 +20,7 @@ jobs:
   check-and-upload-tarballs:
     runs-on: ubuntu-latest
     strategy:
-      fail-fast: ${{ !contains(github.ref_name, 'check') && github.event.inputs.upload-candidates != 'true' }}
+      fail-fast: ${{ github.event.inputs.upload-candidates == 'true' }}
       matrix:
         package: ["hie-compat", "hls-graph", "shake-bench",
                   "hls-plugin-api", "ghcide", "hls-test-utils",
@@ -42,8 +42,6 @@ jobs:
         exclude:
         - ghc: "9.0.2"
           package: "hls-stylish-haskell-plugin"
-        - ghc: "9.0.2"
-          package: "hls-tactics-plugin"
 
     steps:
 
@@ -53,6 +51,7 @@ jobs:
         with:
           ghc: ${{ matrix.ghc }}
           os:  ${{ runner.os }}
+          shorten-hls: 'false'
 
       - name: "Run cabal check"
         run: |
@@ -109,6 +108,7 @@ jobs:
         run: |
           cd $(ls -d ./incoming/${{ matrix.package }}-*)
           # For brittany
+          echo "allow-newer:" >> cabal.project
           echo " butcher:base, multistate:base, data-tree-print:base," >> cabal.project
           # For stylish-haskell
           echo " stylish-haskell:Cabal,stylish-haskell:ghc-lib-parser,stylish-haskell:aeson" >> cabal.project
@@ -139,7 +139,7 @@ jobs:
           path: ${{ steps.generate-dist-tarball.outputs.path }}
 
   upload-candidate:
-    if: ${{ !contains(github.ref_name, 'check') || github.event.inputs.name == 'true' }}
+    if: github.event.inputs.upload-candidates == 'true'
     needs: check-and-upload-tarballs
     runs-on: ubuntu-latest
     steps:

.github/workflows/test.yml

@@ -117,6 +117,9 @@ jobs:
         run: cabal build || cabal build || cabal build
 
       - name: Set test options
+        # run the tests without parallelism, otherwise tasty will attempt to run
+        # all functional test cases simultaneously which causes way too many hls
+        # instances to be spun up for the poor github actions runner to handle
         run: |
           echo "TEST_OPTS=-j1 --rerun-update --rerun-filter failures,exceptions" >> $GITHUB_ENV
 
@@ -142,20 +145,13 @@ jobs:
         env:
           HLS_TEST_EXE: hls
           HLS_WRAPPER_TEST_EXE: hls-wrapper
-        # run the tests without parallelism, otherwise tasty will attempt to run
-        # all functional test cases simultaneously which causes way too many hls
-        # instances to be spun up for the poor github actions runner to handle
         run: cabal test func-test --test-options="$TEST_OPTS" || cabal test func-test --test-options="$TEST_OPTS" || LSP_TEST_LOG_COLOR=0 LSP_TEST_LOG_MESSAGES=true LSP_TEST_LOG_STDERR=true cabal test func-test --test-options="$TEST_OPTS"
 
       - if: matrix.test
         name: Test wrapper-test suite
         env:
           HLS_TEST_EXE: hls
           HLS_WRAPPER_TEST_EXE: hls-wrapper
-        # run the tests without parallelism, otherwise tasty will attempt to run
-        # all functional test cases simultaneously which causes way too many hls
-        # instances to be spun up for the poor github actions runner to handle
-
         run: cabal test wrapper-test --test-options="$TEST_OPTS --rerun-log-file .tasty-rerun-log-wrapper" || cabal test wrapper-test --test-options="$TEST_OPTS  --rerun-log-file .tasty-rerun-log-wrapper" || cabal test wrapper-test --test-options="$TEST_OPTS  --rerun-log-file .tasty-rerun-log-wrapper"
 
       - if: matrix.test && matrix.ghc != '9.2.1'