Skip to content

Commit

Permalink
chore: release v0.0.3-alpha.2
Browse files Browse the repository at this point in the history
* (HGlab01) first release
  • Loading branch information
HGlab01 committed Jun 23, 2023
1 parent 1f63489 commit 24998b7
Show file tree
Hide file tree
Showing 4 changed files with 3,455 additions and 7,514 deletions.
93 changes: 2 additions & 91 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,103 +17,14 @@ Describe your project here
## Developer manual
This section is intended for the developer. It can be deleted later.

### DISCLAIMER

Please make sure that you consider copyrights and trademarks when you use names or logos of a company and add a disclaimer to your README.
You can check other adapters for examples or ask in the developer community. Using a name or logo of a company without permission may cause legal problems for you.

### Getting started

You are almost done, only a few steps left:
1. Create a new repository on GitHub with the name `ioBroker.tinymqttbroker`
1. Initialize the current folder as a new git repository:
```bash
git init -b main
git add .
git commit -m "Initial commit"
```
1. Link your local repository with the one on GitHub:
```bash
git remote add origin https://github.com/HGlab01/ioBroker.tinymqttbroker
```

1. Push all files to the GitHub repo:
```bash
git push origin main
```
1. Add a new secret under https://github.com/HGlab01/ioBroker.tinymqttbroker/settings/secrets. It must be named `AUTO_MERGE_TOKEN` and contain a personal access token with push access to the repository, e.g. yours. You can create a new token under https://github.com/settings/tokens.

1. Head over to [src/main.ts](src/main.ts) and start programming!

### Best Practices
We've collected some [best practices](https://github.com/ioBroker/ioBroker.repositories#development-and-coding-best-practices) regarding ioBroker development and coding in general. If you're new to ioBroker or Node.js, you should
check them out. If you're already experienced, you should also take a look at them - you might learn something new :)

### Scripts in `package.json`
Several npm scripts are predefined for your convenience. You can run them using `npm run <scriptname>`
| Script name | Description |
|-------------|-------------|
| `build` | Compile the TypeScript sources. |
| `watch` | Compile the TypeScript sources and watch for changes. |
| `test:ts` | Executes the tests you defined in `*.test.ts` files. |
| `test:package` | Ensures your `package.json` and `io-package.json` are valid. |
| `test:integration` | Tests the adapter startup with an actual instance of ioBroker. |
| `test` | Performs a minimal test run on package files and your tests. |
| `check` | Performs a type-check on your code (without compiling anything). |
| `lint` | Runs `ESLint` to check your code for formatting errors and potential bugs. |
| `translate` | Translates texts in your adapter to all required languages, see [`@iobroker/adapter-dev`](https://github.com/ioBroker/adapter-dev#manage-translations) for more details. |
| `release` | Creates a new release, see [`@alcalzone/release-script`](https://github.com/AlCalzone/release-script#usage) for more details. |

### Configuring the compilation
The adapter template uses [esbuild](https://esbuild.github.io/) to compile TypeScript and/or React code. You can configure many compilation settings
either in `tsconfig.json` or by changing options for the build tasks. These options are described in detail in the
[`@iobroker/adapter-dev` documentation](https://github.com/ioBroker/adapter-dev#compile-adapter-files).

### Writing tests
When done right, testing code is invaluable, because it gives you the
confidence to change your code while knowing exactly if and when
something breaks. A good read on the topic of test-driven development
is https://hackernoon.com/introduction-to-test-driven-development-tdd-61a13bc92d92.
Although writing tests before the code might seem strange at first, but it has very
clear upsides.

The template provides you with basic tests for the adapter startup and package files.
It is recommended that you add your own tests into the mix.

### Publishing the adapter
Using GitHub Actions, you can enable automatic releases on npm whenever you push a new git tag that matches the form
`v<major>.<minor>.<patch>`. We **strongly recommend** that you do. The necessary steps are described in `.github/workflows/test-and-release.yml`.

Since you installed the release script, you can create a new
release simply by calling:
```bash
npm run release
```
Additional command line options for the release script are explained in the
[release-script documentation](https://github.com/AlCalzone/release-script#command-line).

To get your adapter released in ioBroker, please refer to the documentation
of [ioBroker.repositories](https://github.com/ioBroker/ioBroker.repositories#requirements-for-adapter-to-get-added-to-the-latest-repository).

### Test the adapter manually with dev-server
Since you set up `dev-server`, you can use it to run, test and debug your adapter.

You may start `dev-server` by calling from your dev directory:
```bash
dev-server watch
```

The ioBroker.admin interface will then be available at http://localhost:8081/

Please refer to the [`dev-server` documentation](https://github.com/ioBroker/dev-server#command-line) for more details.

## Changelog
<!--
Placeholder for the next version (at the beginning of the line):
### **WORK IN PROGRESS**
-->
### 0.0.3-alpha.1 (2023-06-18)
* (HGlab01) initial release
### 0.0.3-alpha.2 (2023-06-23)
* (HGlab01) first release

## License
MIT License
Expand Down
15 changes: 14 additions & 1 deletion io-package.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,21 @@
{
"common": {
"name": "tinymqttbroker",
"version": "0.0.3-alpha.1",
"version": "0.0.3-alpha.2",
"news": {
"0.0.3-alpha.2": {
"en": "first release",
"de": "erste veröffentlichung",
"ru": "первый релиз",
"pt": "primeiro lançamento",
"nl": "eerste vrijlating",
"fr": "première version",
"it": "primo rilascio",
"es": "primera liberación",
"pl": "pierwsze wydanie",
"uk": "перший реліз",
"zh-cn": "首次释放"
},
"0.0.3-alpha.1": {
"en": "initial release",
"de": "erstausstrahlung",
Expand Down
Loading

0 comments on commit 24998b7

Please sign in to comment.