Skip to content

Commit

Permalink
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Document maintenance_intent
Browse files Browse the repository at this point in the history
Signed-off-by: ArthurW <[email protected]>
art-w committed Jan 8, 2025

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
1 parent 6cbe3c3 commit be0a9b6
Showing 4 changed files with 21 additions and 0 deletions.
1 change: 1 addition & 0 deletions doc/changes/11274.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
- Support for opam `(maintenance_intent ...)` in dune-project (#11274, @art-w)
2 changes: 2 additions & 0 deletions doc/howto/opam-file-generation.rst
Original file line number Diff line number Diff line change
@@ -81,13 +81,15 @@ For example, if your opam file looks like:
"conduit-async" { >= "1.0.3" }
"async" { >= "v0.10.0" }
]
x-maintenance-intent: [ "(latest)" ]
You can express this as::

(source (github mirage/ocaml-cohttp))
(license ISC)
(authors "Anil Madhavapeddy" "Rudi Grinberg")
(maintainers "[email protected]")
(maintenance_intent "(latest)")

(package
(name cohttp-async)
12 changes: 12 additions & 0 deletions doc/reference/dune-project/generate_opam_files.rst
Original file line number Diff line number Diff line change
@@ -63,6 +63,18 @@ defined in the project:
"Jane Doe <[email protected]>"
"John Doe <[email protected]>")
.. describe:: (maintenance_intent <strings>)

.. versionadded:: 3.18

Specify the `opam maintenance intent <https://github.com/ocaml/opam-repository/blob/master/governance/policies/archiving.md#specification-of-the-x--fields-used-in-the-archiving-process>`__.

Example:

.. code:: dune
(maintenance_intent "(latest)")
.. describe:: (source ...)

.. versionadded:: 1.7
6 changes: 6 additions & 0 deletions doc/reference/dune-project/package.rst
Original file line number Diff line number Diff line change
@@ -60,6 +60,12 @@ package

The same as (and takes precedences over) the corresponding global field.

.. describe:: (maintenance_intent ...)

.. versionadded:: 3.18

The same as (and takes precedences over) the corresponding global field.

.. describe:: (source ...)

.. versionadded:: 2.0

0 comments on commit be0a9b6

Please sign in to comment.