<commit_before># reg-publish-s3-plugin
reg-suit plugin to fetch and publish snapshot images to AWS S3.

## Configure

```sh
npm i reg-publish-s3-plugin
reg-suit prepare -p publish-s3
```

## 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>
```
<commit_msg>write s3 plugin config type<commit_after># reg-publish-s3-plugin
This is a reg-suit plugin to fetch and publish snapshot images to AWS S3.

## Install

```sh
npm i reg-publish-s3-plugin
reg-suit prepare -p publish-s3
```

## 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;
}
```

- `bucketName` - *Required* - AWS S3 bucket name to publish the snapshot images to.

{'fraction_non_alphanumeric': 0.12073863636363637, 'fraction_numerical': 0.009943181818181818, 'mean_word_length': 4.461240310077519, 'pattern_counts': {'":': 0, '<': 11, '<?xml version=': 0, '>': 11, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2544575', 'n_tokens_mistral': 496, 'n_tokens_neox': 475, 'n_words': 157}