docs: update usage for common-repo 0.27.0 workaround
Source-declared filtering is broken (common-repo/common-repo#229). Consumer must use with: clause with include + rename for now. Also documents rename uses $1 not %[1]s (#230).
This commit is contained in:
35
README.md
35
README.md
@@ -15,28 +15,25 @@ Files distributed from `src/`:
|
|||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
### Add to a new repo
|
|
||||||
|
|
||||||
```bash
|
|
||||||
cr init https://github.com/christmas-island/cr-semantic-release
|
|
||||||
```
|
|
||||||
|
|
||||||
### Add to an existing `.common-repo.yaml`
|
### Add to an existing `.common-repo.yaml`
|
||||||
|
|
||||||
```bash
|
|
||||||
cr add https://github.com/christmas-island/cr-semantic-release
|
|
||||||
```
|
|
||||||
|
|
||||||
Or manually:
|
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# .common-repo.yaml
|
# .common-repo.yaml
|
||||||
- repo:
|
- repo:
|
||||||
url: https://github.com/christmas-island/cr-semantic-release
|
url: https://github.com/christmas-island/cr-semantic-release
|
||||||
ref: v1.0.0
|
ref: v1.0.0
|
||||||
path: src/
|
with:
|
||||||
|
- include: ["src/**", "src/.*", "src/.*/**"]
|
||||||
|
- rename:
|
||||||
|
- "^src/(.*)$": "$1"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
> **Note:** Source-declared filtering is not yet functional in common-repo 0.27.0
|
||||||
|
> ([#226](https://github.com/common-repo/common-repo/issues/226),
|
||||||
|
> [#227](https://github.com/common-repo/common-repo/issues/227)).
|
||||||
|
> The `with:` clause above is required until those are fixed, at which point
|
||||||
|
> consumers will only need the `repo:` block.
|
||||||
|
|
||||||
### Apply
|
### Apply
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
@@ -56,7 +53,7 @@ cr-semantic-release/
|
|||||||
├── commitlint.config.js ← this repo's own commitlint
|
├── commitlint.config.js ← this repo's own commitlint
|
||||||
├── README.md
|
├── README.md
|
||||||
├── LICENSE
|
├── LICENSE
|
||||||
└── src/ ← distributed to consumers via path: src/
|
└── src/ ← distributed to consumers
|
||||||
├── .github/workflows/
|
├── .github/workflows/
|
||||||
│ ├── commitlint.yml
|
│ ├── commitlint.yml
|
||||||
│ └── release.yaml
|
│ └── release.yaml
|
||||||
@@ -93,9 +90,10 @@ If you only want a subset:
|
|||||||
- repo:
|
- repo:
|
||||||
url: https://github.com/christmas-island/cr-semantic-release
|
url: https://github.com/christmas-island/cr-semantic-release
|
||||||
ref: v1.0.0
|
ref: v1.0.0
|
||||||
path: src/
|
|
||||||
with:
|
with:
|
||||||
- exclude: [".github/workflows/commitlint.yml"]
|
- include: ["src/.releaserc.yaml", "src/commitlint.config.js"]
|
||||||
|
- rename:
|
||||||
|
- "^src/(.*)$": "$1"
|
||||||
```
|
```
|
||||||
|
|
||||||
### Overriding `.releaserc.yaml`
|
### Overriding `.releaserc.yaml`
|
||||||
@@ -106,7 +104,10 @@ Use common-repo's YAML merge operator to patch specific fields:
|
|||||||
- repo:
|
- repo:
|
||||||
url: https://github.com/christmas-island/cr-semantic-release
|
url: https://github.com/christmas-island/cr-semantic-release
|
||||||
ref: v1.0.0
|
ref: v1.0.0
|
||||||
path: src/
|
with:
|
||||||
|
- include: ["src/**", "src/.*", "src/.*/**"]
|
||||||
|
- rename:
|
||||||
|
- "^src/(.*)$": "$1"
|
||||||
- yaml:
|
- yaml:
|
||||||
source: my-releaserc-overrides.yaml
|
source: my-releaserc-overrides.yaml
|
||||||
dest: .releaserc.yaml
|
dest: .releaserc.yaml
|
||||||
|
|||||||
Reference in New Issue
Block a user