Skip to content

Add stackName to deploy plugin methods and link to CloudFormation docs #754

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
filmaj merged 1 commit into from
Mar 18, 2025
Merged

Add stackName to deploy plugin methods and link to CloudFormation docs #754

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/views/docs/en/guides/developer-experience/custom-cloudformation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Architect [`@plugins`](/docs/en/guides/plugins/overview) are implemented as a No
```javascript
// Do something only for staging deployments
module.exports = { deploy: {
start: async ({ arc, cloudformation, dryRun, inventory, stage }) => {
start: async ({ arc, cloudformation, dryRun, inventory, stackName, stage }) => {
if (stage !== 'staging') return

let config = await getSomeConfig()
Expand Down
16 changes: 10 additions & 6 deletions src/views/docs/en/guides/plugins/deploy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ category: Plugins
description: '<code>deploy</code> lifecycle hook plugins'
---

`deploy` lifecycle hook plugins expose functionality to extend the capabilities of Architect deployments.
`deploy` lifecycle hook plugins expose functionality to extend the capabilities of [Architect deployments](../../../cli/reference/deploy).


## Plugin parameters
Expand All @@ -14,9 +14,10 @@ All `deploy` methods accept async or synchronous functions, and receive a single
| Property | Type | Description |
|-------------------|---------|---------------------------------------------------|
| `arc` | object | Raw Architect project object |
| `cloudformation` | object | CloudFormation deployment |
| `cloudformation` | object | [CloudFormation template][cfn-json] in JSON |
| `dryRun` | boolean | `true` if `--dry-run` or `--eject` flags are used |
| `inventory` | object | [Inventory](./inventory) object |
| `stackName` | string | [CloudFormation stack][cfn-stack] name |
| `stage` | string | `testing`, `staging` or `production` |


Expand All @@ -29,7 +30,7 @@ Example:
```javascript
// Do something only for staging deployments
module.exports = { deploy: {
start: async ({ arc, cloudformation, dryRun, inventory, stage }) => {
start: async ({ arc, cloudformation, dryRun, inventory, stackName, stage }) => {
if (stage !== 'staging') return

let config = await getSomeConfig()
Expand All @@ -50,7 +51,7 @@ Examples:
```javascript
// Create some identifiers associated with custom S3 bucket credentials
module.exports = { deploy: {
services: async ({ arc, cloudformation, dryRun, inventory, stage }) => {
services: async ({ arc, cloudformation, dryRun, inventory, stackName, stage }) => {
// If the user isn't using this plugin, you can just return
if (!arc['myS3Bucket']) return

Expand Down Expand Up @@ -89,7 +90,7 @@ Example:

```javascript
module.exports = { deploy: {
target: async ({ arc, cloudformation, dryRun, inventory, stage }) => {
target: async ({ arc, cloudformation, dryRun, inventory, stackName, stage }) => {
if (dryRun) return

deployToAnotherService({ inventory, stage })
Expand All @@ -107,8 +108,11 @@ Example:
```javascript
const { rm } = require('fs/promises')
module.exports = { deploy: {
end: async ({ arc, cloudformation, dryRun, inventory, stage }) => {
end: async ({ arc, cloudformation, dryRun, inventory, stackName, stage }) => {
await rm(someBuildArtifact)
}
} }
```

[cfn-json]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-overview.html#cfn-concepts-templates
[cfn-stack]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-overview.html#cfn-concepts-stacks
Loading