commit aefd85291bd8d79a0639a1a14965a81d00c0cf9f · anil.recoil.org/opam-repository

+18 -8
governance/policies/archiving.md
···

       15
       15
        
       - "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)

     

       16
       16
        
       - 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.

     

       17
       17
        
       - 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. 

     

       18
       18
       -
       - A package is said to "meet the compiler cutoff thershold" iff its maximum compiler version is greater then or equal to the compiler cutoff threshold.

     

       18
       18
       +
       - A package is said to "meet the compiler cutoff threshold" iff its maximum compiler version is greater then or equal to the compiler cutoff threshold.

     

       19
       19
        
       - The "maintenance intent" of a package refers to the explicitly declared intent of a maintainer to support versions of a package, recorded in the packages `opam` file metadata.

     

       20
       20
        
       

     

       21
       21
        
       ## Policy

     
···

       31
       31
        
       

     

       32
       32
        
       A version of a package may be published on the primary repo, and will continue to remain listed there, so long as the following criteria hold:

     

       33
       33
        
       

     

       34
       34
       -
       1. `ocaml-version`: The package version satisfies the current compiler cutoff threshold.

     

       35
       35
       -
       2. `source-available`: The sources of the package version are available.

     

       36
       36
       -
       3. `maintenance-intent`: The package version falls within a package's maintenance intent, or is a dependency of a package satisfying the primary repo criteria.

     

       37
       37
       -
       4. `installable`: 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.)

     

       34
       34
       +
       1. The package meets the compiler cutoff threshold.

     

       35
       35
       +
       2. The sources of the package version are available.

     

       36
       36
       +
       3. The package version falls within a package's maintenance intent, or is a dependency of a package satisfying the primary repo criteria.

     

       37
       37
       +
       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.)

     

       38
       38
        
       

     

       39
       39
        
       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. 

     

       40
       40
        
       

     
···

       68
       68
        
       ### Specification of the `x-` fields used in the archiving process

     

       69
       69
        
       

     

       70
       70
        
       - `x-reason-for-archival`: 

     

       71
       71
       -
           - Allowed values: A list of strings matching the [primary repo criteria](#primary-repo-criteria) IDs. 

     

       72
       72
       -
           - Meaning: Records the unmet [primary repo criteria](#primary-repo-criteria) motivating the archiving.

     

       73
       73
       -
           - Example: `["ocaml-version", "maintenance-intent"]`

     

       71
       71
       +
           - Allowed values: a list of containing one more of the following strings

     

       72
       72
       +
             `ocaml-version`, `source-unavailable`, `maintenance-intent`, or

     

       73
       73
       +
             `uninstallable`.

     

       74
       74
       +
           - Meaning: Records the unmet [primary repo criteria](#primary-repo-criteria)

     

       75
       75
       +
             motivating the archiving, as follows:

     

       76
       76
       +
               1. `ocaml-version`: The package no longer met the compiler cutoff threshold.

     

       77
       77
       +
               2. `source-unavailable`: The sources of the package version became unavailable.

     

       78
       78
       +
               3. `maintenance-intent`: The package version falls outside of a

     

       79
       79
       +
                  package's maintenance intent, and it is not a dependency of a package

     

       80
       80
       +
                  satisfying any of the primary repo criteria.

     

       81
       81
       +
               4. `uninstallable`: The package version is not installable on any

     

       82
       82
       +
                  of the supported platforms.

     

       83
       83
       +
           - Example: `["ocaml-version", "source-unavailable"]`

     

       74
       84
        
       - `x-opam-repository-commit-hash-at-time-of-archival`:

     

       75
       85
        
           - Allowed values: a string

     

       76
       86
        
           - Meaning: Records the commit hash of the primary repo at the time a package version is archived.