···

       
57
       
57
       
 
       
- A PR will be made to add the archived versions to the archive repo. 

     

       
58
       
58
       
 
       
    - The opam file of each version will be extended as follows:

     

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

     

       
60
       
60
       
-
       
        -  The field `x-reason-for-archival` will be added.

     

       
61
       
61
       
-
       
        -  The field `x-opam-repository-commit-hash-at-time-of-archival` will be added.

     

       
60
       
60
       
+
       
        -  The field `x-reason-for-archiving` will be added.

     

       
61
       
61
       
+
       
        -  The field `x-opam-repository-commit-hash-at-time-of-archiving` will be added.

     

       
62
       
62
       
 
       
- A PR will be made to remove the versions from the primary repo:

     

       
63
       
63
       
 
       
  - The removal PR should link to the corresponding archiving PR.

     

       
64
       
64
       
 
       
  - The commit message should have the title `Archive packages` and its body should contain the hash of the commit that adds the packages to the archive.

     
···

       
67
       
67
       
 
       


     

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

     

       
69
       
69
       
 
       


     

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

     

       
70
       
70
       
+
       
- `x-reason-for-archiving`:

     

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

     
···

       
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"]`

     

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

     

       
84
       
84
       
+
       
- `x-opam-repository-commit-hash-at-time-of-archiving`:

     

       
85
       
85
       
 
       
    - Allowed values: a string

     

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

     

       
87
       
87
       
 
       
    - Example: `"ca32ab3b976aa7abc00c7605548f78a30980d35b"`