Skip to content

2.0.0-rc1 (2021-11-28)

Pre-release
Pre-release
Compare
Choose a tag to compare
@brendanhay brendanhay released this 28 Nov 09:01
· 4203 commits to main since this release
0ccede6

The Amazonka team is happy to announce the availability of the first release candidate for the upcoming 2.0.0 release. This release collects the past few years' worth of bug fixes and AWS service updates, and also includes some fairly major changes to repository organisation and conventions. Some of the highlighted changes include:

  • Sum types for enumerations have been replaced with pattern synonyms over Text, this makes all sum types trivially extensible - no more deserialisation errors when EC2 adds new instance types, regions, etc.
  • The core Network.AWS namespace has been renamed to Amazonka to match the package.
  • Record field names now match the documentation (where possible) and are no longer prefixed - it is now recommended to use generic-lens or optics packages to modify fields, but generated lenses are still provided for compatibility in each respective Amazonka.<Service>.Lens.
  • The main branch is now the singular source of truth. master + develop will continue to exist in their current state(s), but no further commits will occur on these branches.
  • Work has been done to reduce the amount of memory used when compiling large service libraries such as amazonka-ec2.

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

Because of the magnitude of the accumulated changes, we are now entering a stabilisation period before we release to Hackage. During this period, we'd greatly appreciate people testing amazonka against their projects, and reporting issues against the 2.0 milestone. We are aiming for a four-week stabilisation period, but may shorten or lengthen this depending on the volume of issues raised.

The large number of changes and improvements is thanks to all of the individuals who contributed to this release. Big thanks to everyone involved and in particular @endgame for their work driving everything forward.

You can view the latest Haddock documentation which is built against the main branch and published at https://amazonka.brendanhay.nz/ .

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 is now a dependency of amazonka because of AssumeRoleWithWebIdentity 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: 0ccede621e56fb6f240e4850e205cde82d0e4a4b
    subdir: lib/amazonka lib/amazonka-core lib/services/amazonka-sts lib/services/amazonka-<servicename>

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

extra-deps:
- github: brendanhay/amazonka
  commit: 0ccede621e56fb6f240e4850e205cde82d0e4a4b
  subdirs:
  - lib/amazonka
  - lib/amazonka-core
  - lib/services/amazonka-sts
  - lib/services/amazonka-<servicename>