Skip to content

Commit 5fdfad0

Browse files
committed
Remove branch instructions from README
1 parent 51436e4 commit 5fdfad0

File tree

1 file changed

+0
-37
lines changed

1 file changed

+0
-37
lines changed

README.md

-37
Original file line numberDiff line numberDiff line change
@@ -35,42 +35,5 @@ TestEnv.activate("Example") do
3535
end
3636
```
3737

38-
## Where is the code?
39-
The astute reader has probably notice that the default branch of this git repo is basically empty.
40-
This is because we keep all the code in other branches.
41-
One per minor release: `release-1.0`, `release-1.1` etc.
42-
We do this because TestEnv.jl accesses a whole ton of interals of [Pkg](https://github.com/JuliaLang/Pkg.jl).
43-
These internals change basically every single release.
44-
Maintaining compatibility in a single branch for multiple julia versions leads to code that is a nightmare.
45-
As such, we instead maintain 1 branch per julia minor version.
46-
And we tag releases off that branch with major and minor versions matching the julia version supported, but with patch versions allowed to change freely.
47-
48-
- [release-1.0](https://github.com/JuliaTesting/TestEnv.jl/tree/release-1.0) contains the code to support julia v1.0.x
49-
- [release-1.1](https://github.com/JuliaTesting/TestEnv.jl/tree/release-1.1) contains the code to support julia v1.1.x
50-
- [release-1.2](https://github.com/JuliaTesting/TestEnv.jl/tree/release-1.2) contains the code to support julia v1.2.x
51-
- [release-1.3](https://github.com/JuliaTesting/TestEnv.jl/tree/release-1.3) contains the code to support julia v1.3.x
52-
- [release-1.4](https://github.com/JuliaTesting/TestEnv.jl/tree/release-1.4) contains the code to support julia v1.4.x, v1.5.x, and v1.6.x
53-
- This was a rare goldern ages where the internals of Pkg did not change for almost a year.
54-
- [release-1.7](https://github.com/JuliaTesting/TestEnv.jl/tree/release-1.7) contains the code to support julia v1.7.x
55-
- [release-1.8](https://github.com/JuliaTesting/TestEnv.jl/tree/release-1.8) contains the code to support julia v1.8.x
56-
57-
58-
**Do not make PRs against this COVER branch.**
59-
Except to update this README.
60-
Instead you probably want to PR a branch for some current version of Julia.
61-
62-
This is a bit weird for semver.
63-
New features *can* be added in patch release, but they must be ported to all later branches, and patch releases must be made there also.
64-
For the this reason: we *only* support the latest patch release of any branch.
65-
Older ones may be yanked if they start causing issues for people.
66-
67-
68-
## What should I put in my Project.toml `[compat]` section
69-
If using this as a dependency of a package that supports many versions of julia you may wonder what to put in your Project.toml's [compat] section.
70-
Do not fear, the package manager has your back.
71-
If you put in your `[compat]` for `TestEnv=`: `1` or equivalently `1.0` or `1.0` or `1.0.0` or `^1`, or `^1.0` or `^1.0` or `^1.0.0`,
72-
then the package manager is free to choose any compatible version `v` with `1.0.0 <= v < 2.0.0`.
73-
It will thus chose the corret minor version of TestEnv that is compatible with the loaded version of Julia.
74-
7538
### See also:
7639
- [Discourse Release Announcement](https://discourse.julialang.org/t/ann-testenv-jl-activate-your-test-enviroment-so-you-can-use-your-test-dependencies/65739)

0 commit comments

Comments
 (0)