# reg-publish-s3app-plugin

> Fetch and publish snapshot images to AWS S3 and provides ability to accept/reject changes in reg-suit report on s3

Latest version **1.0.2** (published 2018-12-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install reg-publish-s3app-plugin
pnpm add reg-publish-s3app-plugin
yarn add reg-publish-s3app-plugin
bun add reg-publish-s3app-plugin
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2018-12-06 |
| First published | 2018-11-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 271.6 KB |
| Known vulnerabilities | 0 (+2 in 2 direct dependencies) |
| Install scripts | no |
| Author | @sintu |
| Maintainers | azohra-core |
| Keywords | reg, reg-suit-plugin |

## Links

- npm: https://www.npmjs.com/package/reg-publish-s3app-plugin
- npm.io page: https://npm.io/package/reg-publish-s3app-plugin

## Dependencies (4)

- [uuid](https://npm.io/package/uuid.md) ^3.1.0
- [mkdirp](https://npm.io/package/mkdirp.md) ^0.5.1
- [aws-sdk](https://npm.io/package/aws-sdk.md) ^2.77.0
- [reg-suit-util](https://npm.io/package/reg-suit-util.md) ^0.7.6

## Recent versions

- 1.0.2 (latest) — 2018-12-06
- 1.0.1 — 2018-11-21
- 1.0.0 — 2018-11-21

## README

# reg-publish-s3app-plugin
reg-suit plugin to fetch and publish snapshot images to AWS S3. This plugin is an extended version of `reg-publish-s3-plugin`. This plugin provides the facility to approve or reject changes in comparison reports in s3. By using this plugin you can do the below tasks.
1. Approve the changed image and make new image as expected image.
2. Reject the changed image and make the previous image as expected image.
3. Add the new image as expected image.
4. Ignore the new image from reg-suit report.
5. Recover the deleted image.
6. Delete the image permanently that is deleted by reg-suit.

## Install

```sh
npm i reg-publish-s3app-plugin -D
reg-suit prepare -p publish-s3app
```

## AWS Credentials
This plugin needs AWS credentials to access S3. You can set them by the following 2 methods.

### Environment values

```sh
export AWS_ACCESS_KEY_ID=<your-access-key>
export AWS_SECRET_ACCESS_KEY=<your-secret-key>
```

### Create INI file

Create a file at `~/.aws/credentials` and edit it. For example:

```ini
[default]
aws_access_key_id = <your-access-key>
aws_secret_access_key = <your-secret-key>
```

## Configure

```ts
{
  bucketName: string;
  acl?: string;
  sse?: boolean | string;
  customDomain?: string;
  pathPrefix?: string;
}
```

- `bucketName` - *Required* - AWS S3 bucket name to publish the snapshot images to.
- `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`.
- `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`.

## Accept / Reject changes in reg-suit report on s3.
To accept or reject changes in reg-suit s3 report, open reg-suit report in browser and use `aws Identity pool id` for authentication.
To create the s3 Identity pool ID, please follow below steps.
1. Login to https://aws.amazon.com/
2. Sign in to AWS Management Console
3. Click on `Cognito` link
4. Click on `Manage Identity Pools` button
5. Click on `Create new Identity pool` button
6. Enter `Identity pool name`
7. Check on `Enable access to unauthenticated identities`
8. Click on create pool and allow access
9. Now select platform as java script and look for IdentityPoolId. The value of IdentityPoolId should be like `us-east-2:*******`. This IdentityPoolId can be used to make any changes in the reg-suit s3 report.
10. Now go to aws IAM module
11. Click on Roles
12. Look for Cognito_`your_cognito_pool_name`Unauth_Role and click on it
13. Click on `Attach policies` button and search for `AmazonS3FullAccess`
14. Select `AmazonS3FullAccess` and click on `Attach Policy` button.
15. Now you can use your IdentityPoolId (`same that was created in step 9`) to make changes in reg-suit report in s3.

---
_Source: https://npm.io/package/reg-publish-s3app-plugin · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._