2.0.0-rc2 (2023-07-10)

[brendanhay]

The Amazonka team would like to announce the availability of the final release candidate for the upcoming 2.0.0 release. This release contains many more bug fixes and AWS service updates since rc1, including:

• An overhaul of the authentication-related code.
• A new hooks system for clients to inject custom behavior into the request/response lifecycle.
• Nix Flakes (with cabal) are used for development of the library.
• The cryptonite dependency has been replaced with crypton.

Please read the Amazonka CHANGELOG.md for a high-level overview of all the other changes included in the release candidate.

To test the release, you will need to add a source-repository-package section to your cabal.project file for amazonka itself, and for any service libraries you use (amazonka-sts and amazonka-sso are now dependencies of amazonka because of sts:AssumeRoleWithWebIdentity and SSO support):

-- For amazonka
-- Multiple subdirs in a single `source-repository-package` stanza are supported by cabal-install >= 3.2.0.0.
source-repository-package
    type: git
    location: https://github.com/brendanhay/amazonka
    tag: 31f3d044d84912b99e396a97085a9678e699d91f
    subdir: lib/amazonka lib/amazonka-core lib/services/amazonka-sso lib/services/amazonka-sts lib/services/amazonka-<servicename>

Stack users should use an extra-deps: stanza like this:

extra-deps:
- github: brendanhay/amazonka
  commit: 31f3d044d84912b99e396a97085a9678e699d91f
  subdirs:
  - lib/amazonka
  - lib/amazonka-core
  - lib/services/amazonka-sso
  - lib/services/amazonka-sts
  - lib/services/amazonka-<servicename>

Stack users who also use haskell.nix will need to tell haskell.nix which branch to fetch Amazonka commits from by passing a branchMap parameter like this:

pkgs.haskell-nix.project {
  branchMap = {
    "https://github.com/brendanhay/amazonka.git" = {
      31f3d044d84912b99e396a97085a9678e699d91f = "main";
    };
  };

  # Whatever else you normally have here
  src = ...
}

Please file any feedback from testing under the related discussion so the team can finalize the 2.0.0 release.

[endgame]

Excellent news, thanks for cutting the release. We will have to wait for a few packages to catch up before I can add aeson-2.2 support to amazonka and there are a few final chores to do, but this is a big milestone on the road to Hackage.

[axman6]

Whooohooo, well done team! I'll have to go update my things!

In thew stack example above, can

commit: <current revision of the `main` branch>

be replaced with an actual commit that is the RC2 commit? I assume it should be 31f3d044d84912b99e396a97085a9678e699d91f from the Nix file?

[brendanhay]

Yeah, I'll update the release notes to replace the placeholder so it's not ambiguous.

[endgame]

And the branchMap entry as well, I guess.

[brendanhay]

That one was already correct - they're both the same SHA as the release tag.

[axman6]

Also it looks like the links to the authentication-related code, hooks system etc. haven't worked, because GitHub is janky.

[brendanhay]

Seems like absolute https:// urls are needed rather than #<issue-number> shorthand in Discussions, which, is amazing.

[axman6]

Sure is! yeah I could immediately see the reasonable thing you'd done and the unreasonable breakage GitHub had injected.

[brendanhay]

The urls are updated here and also in the discussion, because doing everything in two separate places is the way.

[tfausak]

Would it be possible to add the package tarballs (like amazonka-s3-2.0.0.tar.gz) to the release? That way it would be possible to use them without having to clone the entire repository.

[brendanhay]

Successfully uploaded 338 assets to 2.0.0-rc2

Had to hand crank generator all night keep the rural NZ internet alive, should be attached to the release under "Assets" now.

@endgame I've added scripts/release-tarballs as the potential beginnings of a tag/upload release script. TBD if we want to commit to uploading art{i,e}facts as part of all future releases - it likely isn't necessary once Hackage uploads are in a "healthy" place again.

[endgame]

I think doing it case-by-case is fine. I don't see many projects using release tarballs because Hackage has that covered. Depending on how things go with the large-scale generator reword i'll have to do post-2.0, we might have to do it for a tag here or there.

[tfausak]

I thought this would allow Cabal users to use the package tarballs from GitHub directly, but unfortunately a Cabal bug makes them get downloaded every time: haskell/cabal#9113

However it's still convenient to manually download the tarball and stuff it in a vendor/ directory or something. Thanks!

[endgame]

I finished the 2.0 milestone today, but I'd like to get work running on latest main just to be absolutely sure things are working before we hit the big red button, just in case making amazonka and amazonka-core hlint-clean has caused some subtle breakage.

[brendanhay]

I'd put it in a release discussion (same as this thread) and also a possibly elided form (or pointer/link) into the CHANGELOG.md so it shows up on Hackage.

[brendanhay]

Possibly also update the {cabal,readme}.ede templates to point back to instructions in this repository just so the migration notes show up for each package when you hit https://hackage.haskell.org/package/amazonka-*.

[endgame]

I was thinking a section in the main amazonka readme with pointers to the relevant changelog sections: that would show up on Hackage and means we're not beholden to GitHub any more than we already are. Does that sound OK to you?

I should be able to do this in the next couple of days.

[endgame]

@brendanhay The migration guide has been written and merged, and work is running on latest main (including the EC2 metadata client changes). If you're happy, then I think it's time to tie it all off (update changelog date, build sdists, create tag), and ship the sdists to Hackage. Are you able to do that?

[brendanhay]

See https://github.com/brendanhay/amazonka/releases/tag/2.0.0

[tfausak]

For what it's worth, we upgraded from RC1 to RC2 at work and it went smoothly. Thanks for all your hard work, @endgame & @brendanhay!

[jhrcek]

We upgraded our codebase from RC1 to RC2 2 weeks ago. Since then it's been running in production without any issues.
I appreciate your work on this @endgame and @brendanhay ❤️