Skip to content

Commit d01a32c

Browse files
committed
docs: Notes on prerelease versions
1 parent 244ac47 commit d01a32c

File tree

2 files changed

+58
-7
lines changed

2 files changed

+58
-7
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,24 @@ machines or want to clone / update a pattern of repos without having to
3434
$ pip install --user vcspull
3535
```
3636

37+
### Developmental releases
38+
39+
You can test the unpublished version of vcspull before its released.
40+
41+
- [pip](https://pip.pypa.io/en/stable/):
42+
43+
```console
44+
$ pip install --user --upgrade --pre vcspull
45+
```
46+
47+
- [pipx](https://pypa.github.io/pipx/docs/):
48+
49+
```console
50+
$ pipx install --suffix=@next 'vcspull' --pip-args '\--pre' --force
51+
```
52+
53+
Then use `vcspull@next sync [config]...`.
54+
3755
## configure
3856

3957
add repos you want vcspull to manage to `~/.vcspull.yaml`.

docs/quickstart.md

Lines changed: 40 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,23 +4,56 @@
44

55
## Installation
66

7-
First, install vcspull.
8-
97
For latest official version:
108

119
```console
12-
1310
$ pip install --user vcspull
14-
1511
```
1612

17-
Development version:
13+
Upgrading:
1814

1915
```console
16+
$ pip install --user --user vcspull
17+
```
2018

21-
$ pip install --user -e git+https://github.com/vcs-python/vcspull.git#egg=vcspull
19+
(developmental-releases)=
2220

23-
```
21+
### Developmental releases
22+
23+
New versions of vcspull are published to PyPI as alpha, beta, or release candidates.
24+
In their versions you will see notfication like `a1`, `b1`, and `rc1`, respectively.
25+
`1.10.0b4` would mean the 4th beta release of `1.10.0` before general availability.
26+
27+
- [pip]\:
28+
29+
```console
30+
$ pip install --user --upgrade --pre vcspull
31+
```
32+
33+
- [pipx]\:
34+
35+
```console
36+
$ pipx install --suffix=@next 'vcspull' --pip-args '\--pre' --force
37+
```
38+
39+
Then use `vcspull@next sync [config]...`.
40+
41+
via trunk (can break easily):
42+
43+
- [pip]\:
44+
45+
```console
46+
$ pip install --user -e git+https://github.com/vcs-python/vcspull.git#egg=vcspull
47+
```
48+
49+
- [pipx]\:
50+
51+
```console
52+
$ pipx install --suffix=@master 'vcspull @ git+https://github.com/vcs-python/vcspull.git@master' --force
53+
```
54+
55+
[pip]: https://pip.pypa.io/en/stable/
56+
[pipx]: https://pypa.github.io/pipx/docs/
2457

2558
## Configuration
2659

0 commit comments

Comments
 (0)