Time to cut a new release: November 2021/1.5.0

[jneira]

• It would contain the recent great performance improvements by @pepeiborra
• Also to enable fourmolu for ghc-9.0.1 thanks to @georgefst
• It would be great to have the rename plugin even disabled at runtime by default (Renaming multi component support #2193)
• Anyone would like to drive it this time 🙂 ? this one does not seem to be too cumbersome

github release

• generate the list of pull requests finished since the last release using the haskell script in the project root.
  Nix users should run command gen-hls-changelogs (a wrapper of the script) in nix-shell instead.
• add that list to the actual Changelog with a description of the release.
• bump up versions of changed packages. All are optional but haskell-language-server itself.
• create the tag and make an initial prerelease to trigger the ci workflow (see details below)
• contact ghcup team (#haskell-ghcup irc channel or via its repo) to try to sync our release and its inclusion in ghcup
• check uploaded binaries and the release description (usually the changelog entry) and uncheck the prerelease box
• make public the release in the usual social channels: irc, twitter, reddit, discord, discourse, etc (not required but useful to spread the word 🙂)
  • irc
  • twitter
  • discord
  • discourse
  • reddit

hackage release

• bump up package versions following the pvp specification if they are not already updated
• create ${version}-hackage branch to trigger the hackage github workflow which will upload all changed packages to hackage as candidates
• check manually candidates in hackage
• publish them definitely

//cc @Ailrun @berberman @michaelpj @konn

[Ailrun]

I'm unfortunately insanely occupied with my POPL preparation :(

[jneira]

Dont worry and good luck with the preparation

[jneira]

Well it is time to start the engine:

• I am checking hackage to see what bumps would be needed here: https://github.com/jneira/haskell-language-server/actions/runs/1447761160

@pepeiborra what version bump do you think is needed for ghcide? There is ton of changes (diff here) and i guess some of them would need a major version bump (so maybe it is time to set it to 1.5.0.0)
Also do you think we should wait to #2323?

[pepeiborra]

Yes, it's time for 1.5.0.0.
I'll try to land #2323 this weekend. No need to wait any further

[jneira]

I am afraid that th-extras version with 9.0.1 support has not been released so ghcide can't be built:

src/Language/Haskell/TH/Extras.hs:42:17: error: 

Error: • Expecting one more argument to ‘TyVarBndr’ 

Expected a type, but ‘TyVarBndr’ has kind ‘* -> *’ 

• In the type signature: nameOfBinder :: TyVarBndr -> Name 

| 

42 | nameOfBinder :: TyVarBndr -> Name 

| ^^^^^^^

I've emailed maintainers again asking for the release, but if they don't respond soon we will have to ship without 9.0.1 support

And ping in the issue about just in case: mokus0/th-extras#10

[jneira]

After updating hackage index and invalidate the cache, the build is getting a compile error on ghc-lib-parser-8.10.7.20210828

• run workflow: https://github.com/jneira/haskell-language-server/runs/4187119335?check_suite_focus=true
• issue in ghc-lib repo: ghc-lib-parser-8.10.7.20210828 build error with ghc-9.0.1 digital-asset/ghc-lib#332

[jneira]

Ok, so ghc-lib is not supposed to be buildable with newer ghcs, in the general case:

I assume ghc-lib-parse >= 8.10.5.20210606 is buildable with ghc-9.0.1 as their base bounds allow it.

it's not. generally, we only support building "forward" (or rather, this is a ghc restriction).

And it turns out that stylish-haskell was forcing the build plan to pick ghc-lib-parser-8.10.* although it is not build for ghc-9.0.1. Adding a allow-newer did solve it.

[jneira]

• I've cut the tag and publish the prerelease: https://github.com/haskell/haskell-language-server/releases/tag/1.5.0
  • It has triggered the release build: https://github.com/haskell/haskell-language-server/actions/runs/1475174019
• I've pushed 1.5.0 to gitlab and it triggered the release build there: https://gitlab.haskell.org/haskell/haskell-language-server/-/pipelines/44095 (//cc @hasufell)
• Will push the hackage branch once the github release is done
  • The run checking hackage with 1.5.0 is https://github.com/haskell/haskell-language-server/actions/runs/1475182207

[jneira]

• Github release done
• There had been some build errors in the gitlab pipeline
• Pushed 1.5.0-hackage to start the hackage release: https://github.com/haskell/haskell-language-server/actions/runs/1475412256

[jneira]

The package candidates has been published, only left make them definitive:

• hls-graph-1.5.1.0
• hls-plugin-api-1.2.0.2
• ghcide-1.5.0
• hls-test-utils-1.1.0.1
• hls-eval-plugin-1.2.0.1
• hls-stylish-haskell-plugin-1.0.0.3
• hls-module-name-plugin-1.0.0.2
• hls-pragmas-plugin-1.0.1.1
• hls-haddock-comments-plugin-1.0.0.4
• hls-retrie-plugin-1.0.1.3
• hls-splice-plugin-1.0.0.5
• hls-tactics-plugin-1.5.0.0
• hls-floskell-plugin-1.0.0.2
• hls-explicit-imports-plugin-1.0.1.1
• hls-hlint-plugin-1.0.2.0
• hls-refine-imports-plugin-1.0.0.2
• hls-class-plugin-1.0.1.1
• hls-call-hierarchy-plugin-1.0.1.1
• hls-ormolu-plugin-1.0.1.1
• hls-brittany-plugin-1.0.1.1
• hls-fourmolu-plugin-1.0.1.1
• haskell-language-server-1.5.0.0

[jneira]

All packages has been released to hackage

[ocharles]

Amazing work as always @jneira 😍 !!!

[jneira]

Possible improvements:

• check the gitlab build which generates artifacts for ghcup is working before making the definitive release, like we are doing for hackage (//cc @hasufell)
  • they are failing and maybe will be need source changes
• maybe a little bit paranoic but check the build script which generates artifacts for the github release before making the definitive release

[jneira]

I am gonna reopen the issue until ghcup are updated to include the release

[pepeiborra]

Maybe we could also add a step to the release process to do manual testing using the ghcup codebase, or some other non-trivial project (ghc itself?) to avoid last minute bugs like #2365

[jneira]

Yeah, maybe hls itself could be a good candidate, ghc is too big and hard to setup if you are not already working on it and ghcup too small (although coincidentally has hs-boot files).
Ideally it should automatized in some way, maybe calling hls in the cli in trace mode and examining the logs to see all files are correctly loaded?

[jneira]

The release has been included in ghcup: https://github.com/haskell/ghcup-metadata/blob/master/ghcup-0.0.6.yaml
thanks to @hasufell

[pepeiborra]

Looks like you missed the hls-rename-plugin upload - maybe there's a list that needs to be updated somewhere?

[jneira]

The plugin is disabled by default at build time cause it does not have support for multicomponent projects afair: #2193

We were waiting for a way of disabling by default at runtime to include it at build time: #2193 (comment)

But we could upload it anyways for sure, hls will not include it if you dont set the appropiate flag:

haskell-language-server/haskell-language-server.cabal

Lines 124 to 127 in 2e61b7c

	flag rename
	description: Enable rename plugin
	default: False
	manual: True