Skip to content

Commit 59d419f

Browse files
committed
docs: minor corrections
1 parent f095087 commit 59d419f

2 files changed

Lines changed: 13 additions & 13 deletions

File tree

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ A PowerShell script for managing multiple Git repositories with support for tags
3535
- **Dry Run Mode**: Preview operations without making changes
3636
- **Recursive Dependencies**: Discover and process nested repository dependencies with API compatibility checking
3737
- **Dependency Resolution Modes**: Choose between Agnostic (tag-based) and SemVer (Semantic Versioning) resolution
38-
- **Floating Versions**: Support for SemVer floating version patterns (x.y.*, x.*) for automatic latest version selection
38+
- **Floating Versions**: Support for SemVer floating version patterns (x.y.\*, x.\*) for automatic latest version selection
3939
- **Flexible Compatibility Modes**: Choose between Strict and Permissive API compatibility modes
4040
- **Intelligent Tag Temporal Sorting**: Always-on automatic chronological tag ordering using actual git tag dates with optimized performance
4141
- **Custom Dependency Files**: Per-repository custom dependency file paths and names with proper isolation
@@ -335,7 +335,7 @@ LsiGitCheckout supports two dependency resolution modes that can be mixed within
335335

336336
### Agnostic Mode (Default)
337337

338-
The traditional tag-based resolution using exact tags and explicit API Compatible Tags lists. This mode provides maximum control and flexibility for projects that don't follow strict semantic versioning.
338+
A tag-based resolution using exact tags and explicit API Compatible Tags lists. This mode provides maximum control and flexibility for projects that don't follow strict semantic versioning.
339339

340340
**Key Features:**
341341
- Explicit compatibility definitions via "API Compatible Tags"
@@ -367,7 +367,7 @@ Automatic version resolution based on Semantic Versioning 2.0.0 rules. This mode
367367

368368
**Configuration Examples:**
369369

370-
#### Lowest Applicable Version (traditional)
370+
#### Lowest Applicable Version
371371
```json
372372
{
373373
"Repository URL": "https://github.com/org/library.git",
@@ -378,7 +378,7 @@ Automatic version resolution based on Semantic Versioning 2.0.0 rules. This mode
378378
}
379379
```
380380

381-
#### Floating Patch Version (new in v7.1.0)
381+
#### Floating Patch Version
382382
```json
383383
{
384384
"Repository URL": "https://github.com/org/library.git",
@@ -388,7 +388,7 @@ Automatic version resolution based on Semantic Versioning 2.0.0 rules. This mode
388388
}
389389
```
390390

391-
#### Floating Minor Version (new in v7.1.0)
391+
#### Floating Minor Version
392392
```json
393393
{
394394
"Repository URL": "https://github.com/org/library.git",
@@ -510,7 +510,7 @@ You can use both Agnostic and SemVer modes in the same dependency tree. Each rep
510510
6. **Test your dependency tree** with `-DryRun` before actual checkouts
511511
7. **Use consistent version tag formats** across your organization when using SemVer mode
512512

513-
## API Compatibility Modes
513+
## API Compatibility Modes (Agnostic Mode)
514514

515515
API compatibility modes control how version conflicts are resolved when multiple projects depend on the same repository. These modes apply to Agnostic mode repositories.
516516

@@ -588,7 +588,7 @@ When the same repository is encountered multiple times with different compatibil
588588
.\LsiGitCheckout.ps1 -DisableRecursion
589589
```
590590

591-
## Checkout Tag Selection Algorithm
591+
## Checkout Tag Selection Algorithm (Agnostic Mode)
592592

593593
The script features an intelligent automatic tag selection algorithm using actual git tag dates, providing optimal version selection without any manual configuration required.
594594

docs/migration_guide.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1507,8 +1507,8 @@ Set-Location ..\BusinessLogic
15071507
```
15081508

15091509
**No configuration changes needed** - BusinessLogic automatically benefits from the enhanced capabilities because:
1510-
- `^2.3.0` automatically accepts v2.4.0 (minor version update)
1511-
- `^3.1.0` automatically accepts v3.2.0 (minor version update)
1510+
- `2.*` automatically accepts v2.4.0 (minor version update)
1511+
- `3.*` automatically accepts v3.2.0 (minor version update)
15121512

15131513
Optionally, update BusinessLogic version to document the enhancement:
15141514
```powershell
@@ -1550,19 +1550,19 @@ No configuration changes needed for the root application either.
15501550

15511551
```
15521552
MyApplication
1553-
v1.0.0 (^4.2.0, ^4.6.0)
1553+
v1.0.0 (4.*, 4.*)
15541554
│ 🔄 Auto-benefits from all updates
15551555
┌─────────────┴─────────────┐ throughout the tree
15561556
│ │
15571557
UserInterface BusinessLogic
1558-
v4.2.0 (^3.1.0) v4.6.0→v4.7.0 (^2.3.0, ^3.1.0)
1558+
v4.2.0 (3.*) v4.6.0→v4.7.0 (2.*, 3.*)
15591559
│ │ 🔄 Auto-gets v2.4.0 & v3.2.0
15601560
│ ┌───────┴──────┐
15611561
│ │ │
15621562
CommonControls │ DataAccess
1563-
v3.1.0→v3.2.0 (^2.0.0) ───┘ v2.3.0→v2.4.0 (^2.0.0)
1563+
v3.1.0→v3.2.0 (2.*) ───┘ v2.3.0→v2.4.0 (2.*)
15641564
│ │
1565-
│ ✅ Opted in to v2.0.0 ✅ Opted in to v2.0.0
1565+
│ ✅ Opted in to v2.0.0 ✅ Opted in to v2.0.0
15661566
└──────────────────────────────────┘
15671567
15681568
DatabaseUtils

0 commit comments

Comments
 (0)