Interactive blueprints for setting up an addon with a build, ember-try, release to gh-pages, docs, and more
MIT License
Blueprint for setting up an addon with a build, ember-try scenarios, code coverage, and documentation via YUI
ember install ember-addon-genie
If it is a bug please open an issue on GitHub.
When you first install ember-addon-genie or run the default blueprint via
ember g ember-addon-genie
you will get the following prompt to select which
components you want to include in your addon.
Note: All items are already pre-selected, press SPACE to deselect and ENTER to continue
package.json
to add some missing information such as repo details, author, and demoURL.travis.yml
or run ember g genie-coverage
Get Your CodeClimate Token
Create a CodeClimate account for your github repo
Grab your CODECLIMATE_REPO_TOKEN
from Settings --> Test Coverage --> JavaScript
You will see something along the lines of:
CODECLIMATE_REPO_TOKEN=<YOUR_REPO_TOKEN> codeclimate-test-reporter < lcov.info
1.13
, 2.2
, 2.4
2.5
)gh-pages
branch when you releaseember-cli-yuidoc
ember release
it will publish your addon's demo page AND your updated docs to the gh-pages branchUsage
To view your docs you will need to use
ember serve --docs
Once your server is ready, navigate to localhost:4200/docs
and you should see all your YUIDoc defined classes and modules.
Generate a changelog in markdown by comparing the given version to the given branch of a repo.
Available Options
user
: The repo user or org. Defaults to your current git usernamerepo
: The repo name. Defaults to your current project's nameversion
: The version to be compared with the branch. Defaults to your current repo's versionnew-version
: The new version. This is used to title the changes when written to filebranch
: The branch to compare with the version. Defaults to 'master'write
: If set to true will write to file
. Defaults falsefile
: Path to changelog file. Defaults to 'CHANGELOG.md'ember genie:changelog --user=ember-cli --repo=ember-cli --version=2.6.0 --branch=master --write=true --file=CHANGELOG.md