New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs #71

Merged
merged 1 commit into from Mar 13, 2018

Conversation

Projects
None yet
3 participants
@simonihmig
Copy link
Collaborator

simonihmig commented Mar 11, 2018

Update docs for the new testing APIs, implemented in this addon by #65 and #70.
The old Readme is moved to docs/legacy.md, for users still using the old system (v0.3.0 and below).

@albertjan

This comment has been minimized.

Copy link
Owner

albertjan commented Mar 12, 2018

Looks good!, Might be a good idea to give people a step by step on how to update from 0.3 to 0.4.

README.md Outdated

You can skip tests by adding the `@ignore` annotation above the Scenario or Feature.

Also you can set `ENV.annotations` to an array of annotations (either statically or e.g. by assigning them from an

This comment has been minimized.

@sfbwalder

sfbwalder Mar 12, 2018

Collaborator

Perhaps call this out stronger using:

Test suites

You can set...

This comment has been minimized.

@simonihmig

simonihmig Mar 13, 2018

Collaborator

Added

README.md Outdated
be used to customize the way tests are run.

The implementation for the way certain annotations affect your tests lives in the `tests/yadda-annotations.js` file.
The addon installs a this file with a default implementation as described below, but you can freely customize it at your

This comment has been minimized.

@sfbwalder

sfbwalder Mar 12, 2018

Collaborator

Small typo - extra 'a':

...installs a this...

This comment has been minimized.

@simonihmig

simonihmig Mar 13, 2018

Collaborator

Fixed

README.md Outdated
```

You may specify the version of yadda by changing it in package.json and running `npm install`.

##### Versions <= 0.1.0
## Usage

This comment has been minimized.

@sfbwalder

sfbwalder Mar 12, 2018

Collaborator

Could add upgrade instructions above here. Something like the below with links to appropriate sections below...

Upgrading to v0.4.x

  1. Upgrade your project to use Ember 3.x.
  2. Install the latest version of ember-cli-yadda.
  3. Run ember g ember-cli-yadda to add the most recent files from the blueprint to your project.
  4. Add the appropriate setup annotation to each Feature or Scenario.
  5. Customize tests/helpers/yadda-annotations.js with any additional setup logic that is needed.
  6. Optional - update your steps files to use async / await.
  7. Optional - group your tests into suites by using additional annotations.

This comment has been minimized.

@simonihmig

simonihmig Mar 13, 2018

Collaborator

Thanks for the suggestion! I added this section, with some changes though:

Upgrade your project to use Ember 3.x.

This is not required, you can still run it with older versions!

Also added some more instructions for actually rewriting your step files to the new testing APIs!

@sfbwalder

This comment has been minimized.

Copy link
Collaborator

sfbwalder commented Mar 12, 2018

@simonihmig Appreciate your work on this. It looks good to me. Take/leave my suggestions.

@simonihmig

This comment has been minimized.

Copy link
Collaborator

simonihmig commented Mar 12, 2018

Thanks for feedback y'all! Will update this later today or tomorrow...

@sfbwalder sfbwalder referenced this pull request Mar 12, 2018

Merged

Set Yadda options #72

@simonihmig simonihmig force-pushed the simonihmig:docs branch from 392dcc3 to 5392b69 Mar 13, 2018

@simonihmig

This comment has been minimized.

Copy link
Collaborator

simonihmig commented Mar 13, 2018

Updated this based on the feedback, if everything looks good now, feel free to merge! :)

@simonihmig simonihmig force-pushed the simonihmig:docs branch from 5392b69 to 784ce2e Mar 13, 2018

@sfbwalder sfbwalder merged commit edb09fe into albertjan:master Mar 13, 2018

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment