Skip to content

README.md reworked for V3+ #132

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

README.md reworked for V3+ #132

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 20 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Together with the corresponding **Github Actions** workflow (more on that below)
1. Add this module to your `devDependencies`:

```bash
npm i -D @alcalzone/release-script
npm i -D @alcalzone/release-script @alcalzone/release-script-plugin-iobroker @alcalzone/release-script-plugin-license @alcalzone/release-script-plugin-manual-review
```

2. Add a new `npm` script in `package.json`:
Expand Down Expand Up @@ -56,7 +56,25 @@ Together with the corresponding **Github Actions** workflow (more on that below)
-->
```

4. If necessary (e.g. for custom versioning steps) use a [config file](#configuration-with-a-config-file)
4. Add file `.releaseconfig.json` with the following contents in the root folder of the repository:

```json
{
"plugins": ["iobroker", "license", "manual-review"]
}
```
If your adapter uses TypeScript or React or something else that needs a build step, you can instruct the release script to execute this before committing the changes:

```json
{
"plugins": ["iobroker", "license", "manual-review"],
"exec": {
"before_commit": "npm run build"
}
}
```

5. If necessary (e.g. for custom versioning steps) use a [config file](#configuration-with-a-config-file)

## Usage

Expand Down