Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eventonehq/rva-cli
🛠AWS S3 Review Apps Tools CLI
https://github.com/eventonehq/rva-cli
aws cli gitlab gitlab-ci review review-app s3-bucket
Last synced: about 1 month ago
JSON representation
🛠AWS S3 Review Apps Tools CLI
- Host: GitHub
- URL: https://github.com/eventonehq/rva-cli
- Owner: eventOneHQ
- License: mit
- Created: 2017-06-06T02:03:45.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-01-05T01:51:42.000Z (almost 6 years ago)
- Last Synced: 2024-10-31T18:58:10.836Z (about 2 months ago)
- Topics: aws, cli, gitlab, gitlab-ci, review, review-app, s3-bucket
- Language: JavaScript
- Homepage: https://oss.eventone.page/rva-cli/
- Size: 108 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# RVA-CLI [](https://github.com/eventOneHQ/rva-cli/issues) [](https://raw.githubusercontent.com/eventOneHQ/rva-cli/master/LICENSE) [](https://www.npmjs.com/package/@filiosoft/rva-cli) [](https://www.npmjs.com/package/@filiosoft/rva-cli) [](https://hub.docker.com/r/filiosoft/rva-cli) [](https://www.codacy.com/app/nprail/rva-cli?utm_source=github.com&utm_medium=referral&utm_content=eventOneHQ/rva-cli&utm_campaign=Badge_Grade)
AWS S3 [Review Apps](https://docs.gitlab.com/ee/ci/review_apps/index.html) Tools CLI
## Installation
To install RVA-CLI, run the following:
```
$ npm i -g @filiosoft/rva-cli
```
## Usage
```
Usage: rva [options] [command]
Example: rva start upgrade-to-angular-2
Commands:
start [name] start a S3 review app
stop [name] stop a S3 review app
init [baseName] initialize a project with S3 review apps
publish [baseName] initialize and upload a project with S3 review apps
help [cmd] display help for [cmd]
Options:
-h, --help output usage information
-V, --version output the version number
```
### Configuration
Before using RVA, you need to create a `rva.json` file in your root project folder and set two environment variables. You can do this by running the following.
```
$ rva init [your_base_review_app_name]
```
### Publish Review App
To create an AWS S3 bucket for a static website review app on a git branch called `upgrade-to-angular-2` and then publish the `publicFolder`, run the following.
```
$ rva publish upgrade-to-angular-2
```
This will do the following steps:
1. Run `rva start` (see [below](#start-review-app) for what it does)
2. Upload your `publicFolder`
You will then be able to browse to the following to view the review app:
[http://upgrade-to-angular-2.review.example.com.s3-website-us-east-1.amazonaws.com](http://upgrade-to-angular-2.review.example.com.s3-website-us-east-1.amazonaws.com)
### Start Review App
_If you are using `rva publish` you do not need to start the review app_
To create an AWS S3 bucket for a static website review app on a git branch called `upgrade-to-angular-2`, run the following.
```
$ rva start upgrade-to-angular-2
```
This will do the following steps:
1. Create an S3 bucket
2. Set the bucket policy
3. Enable static website hosting in the bucket
You will then be able to upload your website to the bucket!
### Delete Review App
To delete the S3 review app you created above, run the following.
```
$ rva stop upgrade-to-angular-2
```
This will delete app files in the bucket and the bucket itself.
### Example `.gitlab-ci.yml` With RVA-CLI
```yaml
stages:
- build
- deploy
variables:
BASE_DOMAIN: "review.example.com" # Should be the same as the configured base domain
build:
stage: build
tags:
- docker
image: node:8
script:
- npm build
artifacts:
paths:
- public
start_review:
stage: deploy
tags:
- docker
image: filiosoft/rva-cli:latest
dependencies:
- build
script:
- rva publish ${CI_ENVIRONMENT_SLUG}
environment:
name: review/${CI_BUILD_REF_NAME}
url: http://${CI_ENVIRONMENT_SLUG}.${BASE_DOMAIN}
artifacts:
paths:
- public
stop_review:
stage: deploy
tags:
- docker
image: filiosoft/rva-cli:latest
script:
- rva stop ${CI_ENVIRONMENT_SLUG}
when: manual
environment:
name: review/${CI_BUILD_REF_NAME}
action: stop
```