Skip to content

Commit 9604e63

Browse files
committed
docs: fixed README.md for markdownlint
1 parent 84c6ce6 commit 9604e63

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

rust/patchable/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,23 +37,27 @@ Patchable uses a two-level configuration system:
3737
2. A version-level config file at `docker-images/<PRODUCT>/stackable/patches/<VERSION>/patchable.toml`
3838

3939
The product-level config contains:
40+
4041
- `upstream` - the URL of the upstream repository (such as `https://github.com/apache/druid.git`)
4142
- `default_mirror` - optional: default URL of a mirror repository (such as `https://github.com/stackabletech/druid.git`)
4243

4344
The version-level config contains:
45+
4446
- `base` - the commit hash of the upstream base commit
4547
- `mirror` - optional: URL of the mirror repository for this version, if mirroring is enabled
4648

4749
### Template
4850

4951
If you're adding a completely new product, you need to create the product-level config once:
52+
5053
```toml
5154
# docker-images/druid/stackable/patches/patchable.toml
5255
upstream = "https://github.com/apache/druid.git"
5356
mirror = "https://github.com/stackabletech/druid.git"
5457
```
5558

5659
If you just want to add a new version, initialize the version-level config with patchable:
60+
5761
```sh
5862
cargo patchable init druid 28.0.0 --base=druid-28.0.0 --mirror
5963
```

0 commit comments

Comments
 (0)