You're Invited:Meet the Socket Team at BlackHat and DEF CON in Las Vegas, Aug 7-8.RSVP
Socket
Socket
Sign inDemoInstall

@dotcom-tool-kit/upload-assets-to-s3

Package Overview
Dependencies
8
Maintainers
0
Versions
145
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@dotcom-tool-kit/upload-assets-to-s3

Upload files to a configured AWS S3 bucket.


Version published
Maintainers
0
Created

Readme

Source

@dotcom-tool-kit/upload-assets-to-s3

Upload files to a configured AWS S3 bucket.

Installation

Install @dotcom-tool-kit/upload-assets-to-s3 as a devDependency in your app:

npm install --save-dev @dotcom-tool-kit/upload-assets-to-s3

Add the plugin to your Tool Kit configuration:

plugins:
	- '@dotcom-tool-kit/upload-assets-to-s3'

Options

KeyDescriptionDefault value
accessKeyIdEnvVarvariable name of the project's aws access key id. If uploading to multiple buckets the same credentials will need to work for all.no default value - for backwards compatability the plugin falls back to the default value for accessKeyId
secretAccessKeyEnvVarvariable name of the project's aws secret access keyno default value - for backwards compatability the plugin falls back to the default value for secretAccessKey
accessKeyIdDEPRECATED variable name of the project's aws access key id'aws_access_hashed_assets'
secretAccessKeyDEPRECATED variable name of the project's aws secret access key'aws_secret_hashed_assets'
directorythe folder in the project whose contents will be uploaded to S3'public'
reviewBucketthe development or test S3 bucket['ft-next-hashed-assets-preview']
prodBucketproduction S3 bucket/s; an array of strings. The same files will be uploaded to each. Note: most Customer Products buckets that have a prod and prod-us version are already configured in AWS to replicate file changes from one to the other so you don't need to specify both here. Also, if multiple buckets are specified the same credentials will need to be valid for both for the upload to be successful['ft-next-hashed-assets-prod']
regionthe AWS region your buckets are stored in (let the Platforms team know if you need to upload to multiple buckets in multiple regions)eu-west-1
destinationthe destination folder for uploaded assets. Set to '' to upload assets to the top level of the bucket'hashed-assets/page-kit'
extensionsfile extensions to be uploaded to S3'js,css,map,gz,br,png,jpg,jpeg,gif,webp,svg,ico,json'
cacheControlheader that controls how long your files stay in a CloudFront cache before CloudFront forwards another request to your origin'public, max-age=31536000, stale-while-revalidate=60, stale-if-error=3600'

Example:

'@dotcom-tool-kit/upload-assets-to-s3':
  '@dotcom-tool-kit/upload-assets-to-s3':
    accessKeyId: AWS_ACCESS
    secretAccessKey: AWS_KEY
    prodBucket: ['ft-next-service-registry-prod']
    reviewBucket: ['ft-next-service-registry-dev']
    destination: ''

Testing uploads using the review bucket

You can test uploads to S3 locally on your review bucket to check that you are happy with the configuration. To do this set your NODE_ENV to branch:

$ export NODE_ENV=branch

If the AWS key names for accessing the review bucket are different to the prod bucket then update those in the .toolkitrc.yml.

The UploadAssetsToS3 task can run on any hook so you can configure it to run on a local hook to test deployment from the command line. For example, it could be added to your build:local hook as follows:

plugins:
  - '@dotcom-tool-kit/webpack'
  - '@dotcom-tool-kit/upload-assets-to-s3'
hooks:
  'build:local':
    - WebpackDevelopment
    - UploadAssetsToS3

Then running npm run build will run the UploadAssetsToS3 task on your review bucket.

Tasks

NameDescriptionPreconfigured Hook
UploadAssetsTos3Uploads provided files to a given S3 bucketrelease:remote

FAQs

Package last updated on 10 Jul 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc