Skip to content

Commit 3c49dcc

Browse files
committed
gram
1 parent a8bfff9 commit 3c49dcc

File tree

1 file changed

+29
-25
lines changed

1 file changed

+29
-25
lines changed

README.md

Lines changed: 29 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Raise your Dependency Versions with Jack
1+
# Jack: Raise your Dependency Versions
22

33
**Experimental**: Jack is an experimental project under active development. It is not yet stable, may contain bugs or undergo breaking changes. It's build it in the open with the community feedback.
44

@@ -10,9 +10,9 @@
1010

1111
<br>
1212

13-
The slow and steady way to raise your `composer.json` dependencies versions.
13+
Jack helps you incrementally update your `composer.json` dependencies, ensuring your project stays current without the chaos of outdated packages.
1414

15-
No more outdated dependencies without noticing.
15+
Say goodbye to unnoticed, years-old dependencies!
1616

1717
<br>
1818

@@ -24,38 +24,43 @@ composer require rector/jack --dev
2424

2525
<br>
2626

27-
## Usage
27+
## Why Jack?
28+
29+
Manually upgrading dependencies can be daunting, especially when tackling multiple outdated packages at once. Large upgrades often lead to errors, compatibility issues, and costly delays. Jack automates and simplifies this process by:
30+
31+
- Monitoring outdated dependencies via CI.
32+
- Gradually opening up package versions for safe updates.
33+
- Prioritizing low-risk updates (e.g., dev dependencies).
34+
35+
With Jack, you upgrade **slowly and steadily**, avoiding the stress of massive, error-prone dependency overhauls.
2836

2937
<br>
3038

31-
## 1. Too many outdated dependencies? Let your CI tell you
39+
## Usage
40+
41+
Jack offers two powerful commands to keep your dependencies up to date:
3242

33-
We tend to postpone upgrade and to them in big jumps = once a couple years. The postponing turns upgrades to harder and more costly project. Also, we can face more errors, as some newer version of packages no longer work with our PHP version.
43+
### 1. Too many outdated dependencies? Let your CI tell you
3444

35-
Let CI pay attention to this issue for us.
45+
Postponing upgrades often results in large, risky jumps (e.g., updating every few years). Jack integrates with your CI pipeline to catch outdated dependencies early.
3646

37-
Too many outdated major packages? CI will fail.
47+
Run the `breakpoint` command to check for outdated major packages:
3848

3949
```bash
4050
vendor/bin/jack breakpoint
4151
```
4252

43-
<br>
44-
45-
Default limit of outdated packages is 5.
46-
47-
Do you 15 outdated packages? Make it fit your needs - goal of this command is not to get stressed, but **to keep raising your dependencies one step at a time**:
53+
By default, CI fails if there are more than **5 outdated packages**. Customize this limit to suit your project’s needs:
4854

4955
```bash
5056
vendor/bin/jack breakpoint --limit 13
5157
```
5258

53-
This way, the upgrade will be come to our focus, if we're lacking behind for way too long.
54-
No more: "oops, all our dependencies are 3 years old, let's update them all at once" mayhem.
59+
This ensures upgrades stay on your radar without overwhelming you. No more "oops, our dependencies are three years old" moments!
5560

5661
<br>
5762

58-
## 2. Open up next versions
63+
### 2. Open up Next Versions
5964

6065
We know we're behind the latest versions of our dependencies, but where to start? Which versions should be force to update first? We can get lot of errors if we try to bump wrong end of knot.
6166

@@ -76,33 +81,32 @@ Instead, let composer handle it. How? We open-up package versions to the next ve
7681
}
7782
```
7883

79-
Not forcing, just opening up. If composer won't see any blockers, it will update the package to the next version.
84+
This "opens up" versions without forcing updates. If no blockers exist, Composer will upgrade to the next version.
8085

8186
<br>
8287

83-
You can limit the range of versions to open up by using the `--limit` option (default 5)
88+
#### Command Options
89+
90+
- **Limit the number of packages** to process (default: 5):
8491

8592
```bash
8693
vendor/bin/jack open-versions --limit 3
8794
```
8895

89-
<br>
90-
91-
To try it out without changing the `composer.json`, you can use the `--dry-run` option.
96+
- **Dry run** to preview changes without modifying `composer.json`:
9297

9398
```bash
9499
vendor/bin/jack open-versions --dry-run
95100
```
96101

97-
<br>
98-
99-
It's proven practice to update all dev packages first, as they're safer low hanging fruit:
102+
- **Update dev dependencies first** for safer, low-risk updates:
100103

101104
```bash
102105
vendor/bin/jack open-versions --dev
103106
```
104107

105-
This way we **get slowly and steadily to the next possible version** of our dependencies.
108+
This approach ensures you **progress steadily** toward the latest dependency versions.
109+
106110

107111
<br>
108112

0 commit comments

Comments
 (0)