Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/KonnorRogers/bridgetown-automation-cypress

An automation for adding Cypress to Bridgetown
https://github.com/KonnorRogers/bridgetown-automation-cypress

bridgetown bridgetown-automation bridgetown-plugin cypress

Last synced: about 2 months ago
JSON representation

An automation for adding Cypress to Bridgetown

Awesome Lists containing this project

README

        

![build](https://github.com/ParamagicDev/bridgetown-automation-cypress/workflows/build/badge.svg)

## Prerequisites

- Ruby >= 2.5
- Bridgetown ~> 0.15.0

```bash
bridgetown -v
# => bridgetown 0.15.0 "Overlook"
```

This project requires the new `apply` command introduced in Bridgetown
`0.15.0`

## Usage

### New project

```bash
bridgetown new --apply="https://github.com/ParamagicDev/bridgetown-automation-cypress"
```

### Existing Project

```bash
bridgetown apply https://github.com/ParamagicDev/bridgetown-automation-cypress
```

## Adding tests to a Bridgetown project

Tests are located in the `cypress/integration` file. Check out [Cypress](https://www.cypress.io)
for further documentation on adding Cypress tests.

## Reference Repository

A new project which applies this `automation` will look like the following repository:

[https://github.com/ParamagicDev/bridgetown-example-cypress](https://github.com/ParamagicDev/bridgetown-example-cypress)

## Testing the "apply" command

Right now there is one big integration test which simply
checks that the files were created for Cypress in a new bridgetown project.

In order for the tests to pass, you must first push the branch you're working on and then
wait for Github to update the raw file so the remote automation test will pass

```bash
git clone https://github.com/ParamagicDev/bridgetown-automation-cypress/
cd bridgetown-automation-cypress
bundle install
bundle exec rake test
```

### Testing with Docker

```bash
git clone https://github.com/ParamagicDev/bridgetown-automation-cypress
cd bridgetown-automation-cypress
source docker.env && docker-compose up --build
```