Skip to content

Commit b6cae0b

Browse files
committed
docs: add mf3 s3 deploy usage comments
1 parent f11bbce commit b6cae0b

1 file changed

Lines changed: 26 additions & 0 deletions

File tree

.github/workflows/mfe-s3-bucket-deployment.yml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,29 @@
1+
# MFE S3 Bucket Deployment Workflow
2+
3+
# PURPOSE:
4+
# This workflow builds and deploys a Micro Frontend (MFE) application to an AWS S3 bucket
5+
6+
# TRIGGER:
7+
# This is a reusable workflow that can be called from other workflows using workflow_call.
8+
#
9+
# INPUTS:
10+
# - PROD_BRANCH: Name of the production branch (required) - used to determine environment
11+
12+
# REQUIRED GITHUB VARIABLES (vars):
13+
# - BUCKET_NAME: The name of the S3 bucket where the MFE will be deployed | ** Env Based **
14+
# - PUBLIC_PATH_CDN: The CDN URL where the MFE will be hosted | ** Env Based **
15+
# - NODE_VERSION: Version of Node.js to use for building
16+
# - APP_ID: The ID/name of the MFE application
17+
# - MFE_CONFIG_API_URL: The API URL for the MFE configuration
18+
# - ATLAS_OPTIONS: Optional. Configuration for translation pulling (if empty, step is skipped)
19+
20+
# REQUIRED SECRETS:
21+
# - AWS_ACCESS_KEY_ID: AWS access key ID with permissions to deploy to S3 | ** Env Based **
22+
# - AWS_SECRET_ACCESS_KEY: AWS secret access key | ** Env Based **
23+
# - AWS_DEFAULT_REGION: AWS region where the S3 bucket is located | ** Env Based **
24+
# - AWS_CLOUDFRONT_DISTRIBUTION_ID: CloudFront distribution ID for cache invalidation | ** Env Based **
25+
26+
127
name: MFE S3 Bucket Deployment 🚀
228

329
on:

0 commit comments

Comments
 (0)