Skip to content

Commit 7b66f78

Browse files
committed
feat: Update README.md to reflect breaking changes in v2.0.0 and adjust examples
1 parent a092f73 commit 7b66f78

File tree

2 files changed

+14
-11
lines changed

2 files changed

+14
-11
lines changed

CHANGES.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1010
### New
1111

1212
### Changed
13+
- Update README.md examples to use v2.0.0 and document breaking changes from v1.x
1314

1415
### Fixed
1516

README.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@
77
88
> **📚 Plugin Development Guide**: Since many users of mkp-builder are developing CheckMK plugins, we maintain comprehensive documentation for CheckMK 2.3.x plugin development in [`cmk-pluigin-guide.md`](cmk-api-doc.md). This guide covers agent plugins, check plugins, rulesets, graphing, and bakery integration with practical examples and best practices.
99
10+
> **🚨 Breaking Changes in v2.0.0**: If you're upgrading from v1.x, please note that v2.0.0 introduces breaking changes. The configuration file format has changed from `.mkp-builderrc` to `.mkp-builder.ini` with INI format syntax. GitHub Action input names have also been updated. See the [changelog](CHANGES.md) for full migration details.
11+
1012
A reusable GitHub Action for building CheckMK MKP (Monitoring Konfiguration Package) files from local directory structures.
1113

1214
## Features
@@ -22,7 +24,7 @@ A reusable GitHub Action for building CheckMK MKP (Monitoring Konfiguration Pack
2224

2325
```yaml
2426
- name: Build MKP Package
25-
uses: oposs/mkp-builder@v1
27+
uses: oposs/mkp-builder@v2
2628
with:
2729
version: '1.2.3'
2830
```
@@ -33,10 +35,10 @@ For production use, choose the appropriate versioning strategy:
3335
3436
```yaml
3537
# Pin to exact version (recommended for production)
36-
- uses: oposs/mkp-builder@v1.2.3
38+
- uses: oposs/mkp-builder@v2.0.0
3739

3840
# Pin to major version (gets latest features and fixes)
39-
- uses: oposs/mkp-builder@v1
41+
- uses: oposs/mkp-builder@v2
4042

4143
# Use latest from main branch (not recommended for production)
4244
- uses: oposs/mkp-builder@main
@@ -64,7 +66,7 @@ jobs:
6466
run: echo "version=${GITHUB_REF#refs/tags/v}" >> $GITHUB_OUTPUT
6567

6668
- name: Build MKP
67-
uses: oposs/mkp-builder@v1
69+
uses: oposs/mkp-builder@v2
6870
with:
6971
version: ${{ steps.version.outputs.version }}
7072
```
@@ -74,7 +76,7 @@ jobs:
7476
```yaml
7577
- name: Build MKP Package
7678
id: build-mkp
77-
uses: oposs/mkp-builder@v1
79+
uses: oposs/mkp-builder@v2
7880
with:
7981
version: ${{ github.ref_name }}
8082
package-name: 'my_plugin'
@@ -193,7 +195,7 @@ jobs:
193195
194196
- name: Build MKP
195197
id: build
196-
uses: oposs/mkp-builder@v1
198+
uses: oposs/mkp-builder@v2
197199
with:
198200
version: ${{ steps.version.outputs.version }}
199201
verbose: 'true'
@@ -231,7 +233,7 @@ jobs:
231233
fi
232234
233235
- name: Test build
234-
uses: oposs/mkp-builder@v1
236+
uses: oposs/mkp-builder@v2
235237
with:
236238
version: '0.0.0-test'
237239
validate-python: 'true'
@@ -250,7 +252,7 @@ jobs:
250252
251253
- name: Build MKP
252254
id: build
253-
uses: oposs/mkp-builder@v1
255+
uses: oposs/mkp-builder@v2
254256
with:
255257
version: ${{ steps.version.outputs.version }}
256258
@@ -315,7 +317,7 @@ The action automatically maps files from your local directory structure:
315317
Enable verbose output for detailed logging:
316318
317319
```yaml
318-
- uses: oposs/mkp-builder@v1
320+
- uses: oposs/mkp-builder@v2
319321
with:
320322
version: '1.0.0'
321323
verbose: 'true'
@@ -340,10 +342,10 @@ For production use, pin to a specific version:
340342

341343
```yaml
342344
# Pin to a specific version
343-
- uses: oposs/mkp-builder@v1.2.3
345+
- uses: oposs/mkp-builder@v2.0.0
344346

345347
# Pin to a major version (recommended)
346-
- uses: oposs/mkp-builder@v1
348+
- uses: oposs/mkp-builder@v2
347349

348350
# Use latest (not recommended for production)
349351
- uses: oposs/mkp-builder@main

0 commit comments

Comments
 (0)