reg-publish-s3-plugin

Fetch and publish snapshot images to AWS S3.

MIT 61 个版本
reg reg-suit-plugin
主页
仓库
提交 Issue
安装
npm install reg-publish-s3-plugin
yarn add reg-publish-s3-plugin
pnpm add reg-publish-s3-plugin
bun add reg-publish-s3-plugin
README

reg-publish-s3-plugin

reg-suit plugin to fetch and publish snapshot images to AWS S3.

Install

npm i reg-publish-s3-plugin -D
reg-suit prepare -p publish-s3

Requirements

To use this plugin, you need to create an S3 bucket and configure to allow to access it from your CI.

Configure

{
  bucketName: string;
  acl?: string;
  sse?: boolean | string;
  sseKMSKeyId?: string;
  customDomain?: string;
  pathPrefix?: string;
  sdkOptions?: S3ClientConfig;
}
  • bucketName - Required - AWS S3 bucket name to publish the snapshot images to.
  • enableACL - Optional - Specifies whether ACL is enabled or not. Default true.
  • acl - Optional - Specify ACL property. By default, public-read.
  • sse - Optional - Specify server-side encryption property. Default false. If you set true, this plugin send with --sse="AES256.
  • sseKMSKeyId - Optional - Specify server-side encryption KMS KEY ID. If provided, is passed as SSEKMSKeyId to s3.putObject.
  • customDomain - Optional - Set if you have your domain and host S3 on it. If set, the HTML report will be published with this custom domain(e.g. https://your-sub.example.com/...).
  • pathPrefix - Optional - Specify paths. For example if you set some_dir, the report is published with URL such as https://your-backet-name.s3.amazonaws.com/some_dir/xxxxxxxxx/index.html.
  • sdkOptions - Optional - Specify options to pass to S3Client constructor. For details about the options, refer to the AWS JavaScript SDK docs.

IAM Role Policy

This plugin needs following role policy.

  "Action": [
    "s3:DeleteObject",
    "s3:GetObject",
    "s3:GetObjectAcl",
    "s3:PutObject",
    "s3:PutObjectAcl",
    "s3:ListBucket"
  ]
版本列表
0.14.4 2024-05-02
0.14.3 2024-03-05
0.14.2 2024-03-01
0.14.0 2024-02-26
0.13.0 2024-01-19
0.12.2 2023-07-04
0.12.1 2022-06-08
0.11.0 2021-10-27
0.10.17 2021-10-16
0.10.16 2021-06-08
0.10.15 2021-03-12
0.10.10 2020-12-22
0.10.9 2020-12-04
0.10.8 2020-10-26
0.10.7 2020-09-18
0.10.6 2020-09-14
0.10.3 2020-09-10
0.9.0 2019-12-25
0.8.5 2019-12-02
0.7.25 2019-09-03
0.7.23 2019-07-11
0.7.22 2019-03-31
0.7.18 2018-11-16
0.7.16 2018-11-13
0.7.10 2018-07-12
0.7.6 2018-07-08
0.7.5 2018-06-29
0.7.4 2018-06-13
0.7.3 2018-05-17
0.7.2 2018-03-30
0.7.1 2018-03-27
0.7.0 2018-01-10
0.6.3 2017-12-11
0.6.1 2017-11-30
0.6.0 2017-11-21
0.5.9 2017-11-10
0.5.6 2017-09-29
0.5.5 2017-09-21
0.5.4 2017-09-19
0.5.1 2017-08-15
0.5.0 2017-08-08
0.4.3 2017-08-04
0.4.0 2017-07-31
0.3.1 2017-07-26
0.2.6 2017-07-25
0.2.3 2017-07-21
0.2.1 2017-07-20
0.2.0 2017-07-19
0.1.0 2017-07-16
0.0.20 2017-07-14
0.0.19 2017-07-14
0.0.17 2017-07-07
0.0.14 2017-07-06
0.0.13 2017-07-05
0.0.10 2017-07-03
0.0.9 2017-07-03
0.0.8 2017-07-03
0.0.7 2017-07-03
0.0.5 2017-07-03
0.0.4 2017-07-01
0.0.3 2017-07-01