Skip to content

Commit

Permalink
Merge pull request #2458 from guardian/changeset-release/main
Browse files Browse the repository at this point in the history
🦋 Release package updates
  • Loading branch information
akash1810 committed Sep 17, 2024
2 parents 3588b24 + 7189b9e commit 3d81b92
Show file tree
Hide file tree
Showing 3 changed files with 47 additions and 44 deletions.
43 changes: 0 additions & 43 deletions .changeset/happy-badgers-compare.md

This file was deleted.

46 changes: 46 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,51 @@
# @guardian/cdk

## 59.5.0

### Minor Changes

- f4e2a7c: feat(experimental-ec2-pattern): Pattern to deploy ASG updates w/CFN

Included in this update is a new experimental pattern `GuEc2AppExperimental`, which can be used in place of a `GuEc2App`:

```ts
import { GuEc2AppExperimental } from "@guardian/cdk/lib/experimental/patterns/ec2-app";
```

This pattern will add an [`AutoScalingRollingUpdate` policy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html#cfn-attributes-updatepolicy-rollingupdate)
to the autoscaling group.
This allows application updates to be performed like a standard CloudFormation update,
and using the custom logic provided by Riff-Raff's `autoscaling` deployment type is unnecessary.

This experimental pattern has few requirements.

## Add the build number to the application artifact

This change requires versioned artifacts.

The easiest way to achieve this is by adding the build number to the filename of the artifact:

```ts
import { UserData } from "aws-cdk-lib/aws-ec2";
// Use a GitHub Actions provided environment variable
const buildNumber = process.env.GITHUB_RUN_NUMBER ?? "DEV";
const userData = UserData.forLinux();
userData.addCommands(`aws s3 cp s3://dist-bucket/path/to/artifact-${buildNumber}.deb /tmp/artifact.deb`);
userData.addCommands(`dpkg -i /tmp/artifact.dep`);
```
## `riff-raff.yaml`
The `riff-raff.yaml` file should remove the `deploy` action of the `autoscaling` deployment type.
Though including it shouldn't break anything, it would result in a longer deployment time as instance will be rotated by both CloudFormation and Riff-Raff's custom logic.
The `uploadArtifacts` step of the `autoscaling` deployment type should still be included, with the `cloud-formation` deployment type depending on it.
This step uploads the versioned artifact to S3.
> [!TIP]
> An [auto-generated `riff-raff.yaml` file](https://github.com/guardian/cdk/blob/main/src/riff-raff-yaml-file/README.md) meets this requirement.
## 59.4.0
### Minor Changes
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@guardian/cdk",
"description": "Generic Guardian flavoured AWS CDK components",
"version": "59.4.0",
"version": "59.5.0",
"main": "lib/index.js",
"types": "lib/index.d.ts",
"files": [
Expand Down

0 comments on commit 3d81b92

Please sign in to comment.