this repo has no description
Merge pull request #27279 from hannesm/update-archiving-policy
minor updates for the archiving policy as discussed today in the meeting
authored by
Marcello Seri
and committed by
GitHub
3f795598
ef4b0792
+18
-6
+18
-6
governance/policies/archiving.md
+18
-6
governance/policies/archiving.md
···
4
4
5
5
- The primary opam repository, (referred to here as the "primary repo") is located at [ocaml/opam-repository](https://github.com/ocaml/opam-repository). The primary repo is curated to ensure that compatible packages are co-installable on as many supported platforms as possible, and it is the default package repository.
6
6
- "Primary repo criteria" refers to the criteria used to decide whether a version of a package is suitable for continued inclusion in the primary repo.
7
-
- The archive opam repository, (referred to here as the "archive repo")" is located at [ocaml/opam-repository-archive](https://github.com/ocaml/opam-repository-archive) and records packages that were once in the primary repo, but no longer meet the primary repo criteria.
7
+
- The archive opam repository, (referred to here as the "archive repo") is located at [ocaml/opam-repository-archive](https://github.com/ocaml/opam-repository-archive) and records packages that were once in the primary repo, but no longer meet the primary repo criteria.
8
8
- "Supported platforms" are those listed under [Tier 1 and Tier 2 by the OCaml compiler](https://github.com/ocaml/ocaml?tab=readme-ov-file#overview)
9
9
- A package's "maximum compiler version" is the upper bound of the OCaml compiler versions supported by a package. Support is derived either based on explicit version bounds set on the `ocaml` dependency in a package's dependency cone, or implicitly based on failed installs detected through our CI and health check processes.
10
10
- The "compiler cutoff threshold" is an OCaml compiler versions stipulated by the opam repository maintainers. It sets a lower bound on the compiler versions supported by the primary repo.
···
15
15
16
16
### Compiler cutoff threshold
17
17
18
-
The current compiler cutoff threshold is `4.08`.
18
+
The current (2025-02-01) compiler cutoff threshold is `4.08`.
19
19
20
20
This threshold is subject to change by the opam repo maintainers.
21
-
The threshold is based on the oldest ocaml compiler version available
21
+
The threshold is based on the oldest ocaml compiler version available
22
22
in the maintained[^1] distributions. It determines the minimum
23
23
compiler version used in tests for the opam-repository CI[^2].
24
24
···
34
34
3. The package version falls within a package's maintenance intent, or is a dependency of a package satisfying the primary repo criteria.
35
35
4. The package version is installable on at least one of the supported platforms. (Note that it is not required that CI tests are passing, since working installation may require manual system configuration.)
36
36
37
-
Note that this property is transitive along a package's dependency tree: if a package satisfies the primary repo criteria, then its dependencies do as well.
37
+
Note that this property is transitive along a package's dependency tree: if a package satisfies the primary repo criteria, then its dependencies do as well.
38
38
39
39
### Periodic pruning process
40
40
···
52
52
53
53
When it has been decided that a set of package versions (aka "versions") should be archived, archiving will proceed according to the following process:
54
54
55
-
- A PR will be made to add the archived versions to the archive repo.
55
+
- A PR will be made to add the archived versions to the archive repo.
56
56
- The opam file of each version will be extended as follows:
57
57
- Any dependencies without upper bounds will have upper bounds added, recording the latest available version of the dependency in the primary repo at the time of archiving.
58
58
- The field `x-reason-for-archiving` will be added.
···
88
88
- Meaning:
89
89
- Expresses the declared intent of the maintainers to maintain only certain versions ranges of a package.
90
90
- The value of the `x-maintenance-intent` on the latest published package will precedence.
91
+
- Default value: ["(any)"] on 2025-01-17, please note that this default is expected to change in the future
91
92
- Examples:
92
-
- `["(latest)"]` the maintainer will only maintain the latest version
93
+
- `["(latest)"]` the maintainer will only maintain the latest version[^caveat]
94
+
[^caveat]: note that this will retain the latest versions of this package so that every supported OCaml version will have an installation candidate.
93
95
- `["(latest)" "(latest-1)"]` the maintainer will only maintain the latest `X.Y.Z` version and `(X-1).Y.Z`
94
96
- `["(latest)" "(latest).(latest-1)"]` the maintainer will only maintain the latest `X.Y.Z` version and `X.(Y-1).Z`
95
97
- `["(any).(latest)"]` the maintainer will maintain every major version X for each X.Y.Z
···
98
100
- `["(none)"]` the maintainer will not maintain any version
99
101
- `["1.3"]` the maintainer will maintain the latest version of "1.3.Z"
100
102
- `["2.(latest)"]` the maintainer will maintain the latest minor version specifically of version "2" of the package
103
+
- `x-maintained`:
104
+
- Allowed values: `true` and `false`
105
+
- Meaning:
106
+
- Expresses that this opam package version is maintained (if `true`) or not (if `false`).
107
+
- Overrides the `x-maintenance-intent` field
108
+
- Useful for packages that do not specify the `x-maintenance-field` yet, but would like to mark certain pre-releases or old releases as unmaintained, and thus ok for archival
109
+
- Also useful if there's need to maintain a specific version (i.e. an OCaml application that is used and maintained which uses a specific package version)
110
+
- Examples:
111
+
- `false` if this package and version meets the `x-maintenance-intent`, but this version is not maintained and can be archived
112
+
- `true # used by @bactrian, added on 2025-01-24` where @bactrian wants to keep this package in the opam-repository
101
113
102
114
## References
103
115