Skip to content

Commit

Permalink
Update markdown files to match own prettier config
Browse files Browse the repository at this point in the history
  • Loading branch information
simonihmig committed May 16, 2023
1 parent 7409813 commit 3728e2f
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 44 deletions.
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,22 +103,21 @@ By default, `test-app` will be used.

### `--addon-only`

Will only create the addon, similar to the v1 addon behavior of `ember addon my-addon`.
This is useful for incremental migrations of v1 addons to v2 addons where the process from the
Will only create the addon, similar to the v1 addon behavior of `ember addon my-addon`.
This is useful for incremental migrations of v1 addons to v2 addons where the process from the
[Porting Addons to V2](https://github.com/embroider-build/embroider/blob/main/PORTING-ADDONS-TO-V2.md)
guide.

```bash
ember addon my-addon -b @embroider/addon-blueprint --addon-only
# generates non-monorepo:
# my-addon/
# .git
# .git
# package.json
```

For incremental migration in monorepos, you'll want to also supply the `--skip-git` flag.


#### `--release-it`

If you want release-it behavior, (specifically provided by `create-rwjblue-release-it-setup`),
Expand Down
16 changes: 8 additions & 8 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,24 +17,24 @@ guiding principle here is that changelogs are for humans, not machines.

When reviewing merged PR's the labels to be used are:

* breaking - Used when the PR is considered a breaking change.
* enhancement - Used when the PR adds a new feature or enhancement.
* bug - Used when the PR fixes a bug included in a previous release.
* documentation - Used when the PR adds or updates documentation.
* internal - Used for internal changes that still require a mention in the
- breaking - Used when the PR is considered a breaking change.
- enhancement - Used when the PR adds a new feature or enhancement.
- bug - Used when the PR fixes a bug included in a previous release.
- documentation - Used when the PR adds or updates documentation.
- internal - Used for internal changes that still require a mention in the
changelog/release notes.

## Release

Once the prep work is completed, the actual release is straight forward:

* First, ensure that you have installed your projects dependencies:
- First, ensure that you have installed your projects dependencies:

```sh
pnpm install
```

* Second, ensure that you have obtained a
- Second, ensure that you have obtained a
[GitHub personal access token][generate-token] with the `repo` scope (no
other permissions are needed). Make sure the token is available as the
`GITHUB_AUTH` environment variable.
Expand All @@ -47,7 +47,7 @@ pnpm install

[generate-token]: https://github.com/settings/tokens/new?scopes=repo&description=GITHUB_AUTH+env+variable

* And last (but not least 😁) do your release.
- And last (but not least 😁) do your release.

```sh
npx release-it
Expand Down
26 changes: 13 additions & 13 deletions files/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,30 +2,30 @@

## Installation

* `git clone <repository-url>`
* `cd <%= addonName %>`
* `<% if (yarn) { %>yarn<% } else if (pnpm) { %>pnpm<% } else { %>npm<% } %> install`
- `git clone <repository-url>`
- `cd <%= addonName %>`
- `<% if (yarn) { %>yarn<% } else if (pnpm) { %>pnpm<% } else { %>npm<% } %> install`

## Linting

* `<% if (yarn) { %>yarn lint<% } else if (pnpm) { %>pnpm lint<% } else { %>npm run lint<% } %>`
* `<% if (yarn) { %>yarn lint:fix<% } else if (pnpm) { %>pnpm lint:fix<% } else { %>npm run lint:fix<% } %>`
- `<% if (yarn) { %>yarn lint<% } else if (pnpm) { %>pnpm lint<% } else { %>npm run lint<% } %>`
- `<% if (yarn) { %>yarn lint:fix<% } else if (pnpm) { %>pnpm lint:fix<% } else { %>npm run lint:fix<% } %>`

## Building the addon

* `cd <%= addonInfo.location %>`
* `<% if (yarn) { %>yarn<% } else if (pnpm) { %>pnpm<% } else { %>npm<% } %> build`
- `cd <%= addonInfo.location %>`
- `<% if (yarn) { %>yarn<% } else if (pnpm) { %>pnpm<% } else { %>npm<% } %> build`

## Running tests

* `cd <%= testAppInfo.location %>`
* `<% if (yarn) { %>yarn test<% } else if (pnpm) { %>pnpm test<% } else { %>npm run test<% } %>` – Runs the test suite on the current Ember version
* `<% if (yarn) { %>yarn test:watch<% } else if (pnpm) { %>pnpm test:watch<% } else { %>npm run test:watch<% } %>` – Runs the test suite in "watch mode"
- `cd <%= testAppInfo.location %>`
- `<% if (yarn) { %>yarn test<% } else if (pnpm) { %>pnpm test<% } else { %>npm run test<% } %>` – Runs the test suite on the current Ember version
- `<% if (yarn) { %>yarn test:watch<% } else if (pnpm) { %>pnpm test:watch<% } else { %>npm run test:watch<% } %>` – Runs the test suite in "watch mode"

## Running the test application

* `cd <%= testAppInfo.location %>`
* `<% if (yarn) { %>yarn start<% } else if (pnpm) { %>pnpm start<% } else { %>npm run start<% } %>`
* Visit the test application at [http://localhost:4200](http://localhost:4200).
- `cd <%= testAppInfo.location %>`
- `<% if (yarn) { %>yarn start<% } else if (pnpm) { %>pnpm start<% } else { %>npm run start<% } %>`
- Visit the test application at [http://localhost:4200](http://localhost:4200).

For more information on using ember-cli, visit [https://cli.emberjs.com/release/](https://cli.emberjs.com/release/).
27 changes: 8 additions & 19 deletions files/README.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,26 @@
<%= addonName %>
==============================================================================
# <%= addonName %>

[Short description of the addon.]

## Compatibility

Compatibility
------------------------------------------------------------------------------
- Ember.js v3.28 or above
- Embroider or ember-auto-import v2

* Ember.js v3.28 or above
* Embroider or ember-auto-import v2


Installation
------------------------------------------------------------------------------
## Installation

```
ember install <%= addonName %>
```


Usage
------------------------------------------------------------------------------
## Usage

[Longer description of how to use the addon in apps.]


Contributing
------------------------------------------------------------------------------
## Contributing

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


License
------------------------------------------------------------------------------
## License

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

0 comments on commit 3728e2f

Please sign in to comment.