https://github.com/greatwizard/ember-circleci

CircleCI configuration generator for your Ember projects.
https://github.com/greatwizard/ember-circleci

circle-ci circle-ci-2 circleci circleci2 ember ember-addon emberjs generator hacktoberfest

Last synced: 26 days ago
JSON representation

CircleCI configuration generator for your Ember projects.

• Host: GitHub
• URL: https://github.com/greatwizard/ember-circleci
• Owner: GreatWizard
• License: mit
• Created: 2018-09-14T11:33:33.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2022-12-10T17:11:01.000Z (almost 2 years ago)
• Last Synced: 2024-10-09T16:34:28.035Z (27 days ago)
• Topics: circle-ci, circle-ci-2, circleci, circleci2, ember, ember-addon, emberjs, generator, hacktoberfest
• Language: JavaScript
• Homepage:
• Size: 2.9 MB
• Stars: 18
• Watchers: 2
• Forks: 5
• Open Issues: 20
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Ember-CircleCI

[![CircleCI](https://circleci.com/gh/GreatWizard/ember-circleci.svg?style=shield)](https://circleci.com/gh/GreatWizard/ember-circleci)

[![Ember Observer Score](https://emberobserver.com/badges/ember-circleci.svg)](https://emberobserver.com/addons/ember-circleci)

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

[![Liberapay](http://img.shields.io/liberapay/patrons/GreatWizard.svg?logo=liberapay)](https://liberapay.com/GreatWizard/)

CircleCI configuration generator for your Ember projects.

The generated configuration is compatible with applications and addons.

In addition, it uses parallel jobs to optimize CI time.

## Installation

```

ember install ember-circleci

```

## Usage

```

ember g ember-circleci [--exam=X]

```

### Options

- `--exam=X`: Use [`ember-exam`](https://github.com/ember-cli/ember-exam) to run tests in parallel, X is the number of parallel processes (default value is 4)

## Generated configuration

This addon generates the `.circleci/config.yml` file.

Lint and Tests jobs are started as parallel jobs.

If you activate ember-exam, it provides the ability to split, parallelize, and load-balance your test suite.

For an app, built assets will build once and then be re-used during parallelization to further speed up builds.

If ember-exam is not activated, it provides reports of the tests by using xUnit.

xUnit generates an xml file and expose it to CircleCI, that way it can gave a quick overview of the failing tests

After the install dependencies job, the `node_modules` folder is cached by CircleCI to speed up the next runs.

:bulb: If you later need to regenerate the `.circleci/config.yml` file, run `ember g ember-circleci [--exam=X]`.

### Configuration for application

It will provides a `test_and_build` workflow, as follows:

![prepare / run lint (js and hbs) / run tests (default)](https://raw.githubusercontent.com/GreatWizard/ember-circleci/master/doc/workflow-app.png)

### Configuration for addon

It will provides a `test_matrix` workflow, as follows:

![prepare / run lint (js and hbs) and tests (default) / run tests (LTS 3.16, LTS 3.20, release, beta, canary, default with jquery and classic)](https://raw.githubusercontent.com/GreatWizard/ember-circleci/master/doc/workflow-addon.png)

## Contributing

See the [Contributing](CONTRIBUTING.md) guide for details.

## License

This project is licensed under the [MIT License](LICENSE.md).