Maintenance: fix version bump in examples

[dreamorosi]

Summary

Every time we make a release we want the examples present in the repository under examples/* to use the latest version of the Powertools utilities. This allows to keep the examples in sync with the current feature set.

Why is this needed?

We want to make sure that the examples that we offer are accurate and work with the latest release published on npm. Currently this requires a manual version bump after a release, which can be problematic.

Which area does this relate to?

Tests

Solution

TBD

Acknowledgment

• This request meets Lambda Powertools Tenets
• Should this be considered in other Lambda Powertools languages? i.e. Python, Java, and .NET

Future readers

Please react with 👍 and your use case to help us understand customer demand.

[dreamorosi]

Currently the examples are not part of the npm workspace but are part of the lerna one. This means that they are excluded from most of the workspace actions but still get versioned every time a release is made. This last bit is also the reason why the examples are out of sync and are always a version behind the published one.

Basically the version command of both examples installs the latest version of the utilities from npm. This however happens before the publish action has been performed.

To solve/go around the issue I'm thinking of two options:

1. Make the examples part of the npm workspace
2. Add a new step to the release process that increments the version

Between these two I'm leaning towards number 1.

Making the examples folders part of the npm workspace would remove the need to bump the version numbers altogether given that the dependencies would be linked. This would also mean that whenever there's a change to the libraries the examples should be updated as well (assuming it's a breaking change). Finally, using this method would also slightly simplify the setup process of the repo requiring a single npm ci.

[dreamorosi]

After starting to work on this, I think we'll need to do both methods described above after all.

Including the packages in the workspace is needed as it consolidates the packages & configs and removes duplication, however we still need find a way to increase the version number in the examples (see example below) when a release happens.

Currently both examples/cdk and examples/sam have a package.json that references the utilities as devDependencies/dependencies. The version number there is fixed but should/could be bumped as a release happens.

[dreamorosi]

After additional investigation and after having moved both examples under the npm workspace, removing the current existing version command from their respective package.json files allows lerna to version & bump the dependencies in the examples 🎉

I'll push a PR soon.

[github-actions]

⚠️ COMMENT VISIBILITY WARNING ⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.