|
1 | 1 | # octoherd-script-renovate-library-major-version-driver |
2 | 2 |
|
3 | 3 | <!-- [](https://www.npmjs.com/package/@octoherd/script-hello-world) --> |
| 4 | + |
4 | 5 | [](https://github.com/time-loop/octoherd-script-renovate-library-major-version-driver/actions?query=workflow%3ATest+branch%3Amain) |
5 | 6 |
|
6 | 7 | ## Usage |
7 | 8 |
|
8 | 9 | ```bash |
9 | 10 | nvm use v18 |
10 | 11 | node cli.js \ |
11 | | - -R time-loop/*-cdk \ |
| 12 | + -R time-loop/\*-cdk \ |
12 | 13 | -T ghp_0123456789abcdefghijABCDEFGHIJabcdefgh \ |
13 | 14 | --octoherd-bypass-confirms true \ |
14 | | - --majorVersion v11 |
| 15 | + --library @time-loop/cdk-ecs-fargate \ |
| 16 | + --versionRequirement \>=5.15.2 |
15 | 17 | ``` |
16 | 18 |
|
17 | 19 | ## Options |
18 | 20 |
|
19 | | -| option | type | default | description | |
20 | | -| ----------------- | ------ | ------- | ------------------ | |
21 | | -| `--majorVersion` | string | none | major version number for the library, for example v11 | |
22 | | -| `--libray` | string | `@time-loop/cdk-library` | full name of the library to be updated via renovate | |
23 | | - |
24 | | - |
25 | | -## TODO |
26 | | - |
27 | | -- detect and address case where PR is not up-to-date with base branch. |
| 21 | +| option | type | default | description | |
| 22 | +| ---------------------- | ------ | ------------------------ | --------------------------------------------------- | |
| 23 | +| `--versionRequirement` | string | none | requirement for the library, for example `14.*` | |
| 24 | +| `--library` | string | `@time-loop/cdk-library` | full name of the library to be updated via renovate | |
28 | 25 |
|
| 26 | +See [semver](https://www.npmjs.com/package/semver) for details around specifying the `versionRequirement`. |
29 | 27 |
|
30 | 28 | ## Limitations |
31 | 29 |
|
32 | 30 | - Should be re-written in TypeScript, but all examples were JS, and we're tight for time. |
33 | 31 | - Not projen-ified, which is kinda tragic. |
34 | 32 | I feel that these two technologies are deeply complementary. |
35 | 33 | https://github.com/projen/projen/issues/2841 |
36 | | -- Doesn't differentiate between failed status checks which are required vs optional. |
37 | | - Or... maybe the rollup does? I haven't checked. |
38 | 34 | - Not published to npmjs.com, so you have to run it locally. |
39 | 35 | We use github packages, so... we'll probably never publish this to npmjs.com. |
40 | 36 | Either way, not a priority right now. |
|
0 commit comments