package opam-publish
Install
Dune Dependency
Authors
Maintainers
Sources
md5=932949c1a72112404e2e9b55bf1a2fee
sha512=9c95d99279d0c8a21c117bd3d4a47f310ec61b404412cea1f5e89ed7171cd37b0aa750f60f03f28cd8028eab03fe7dd08c050ef9a2ffca80cacfa1ae101a40ae
Description
opam-publish automates publishing packages to package repositories: it checks that the
opam file is complete using opam lint
, verifies and adds the archive URL and its
checksum and files a GitHub pull request for merging it.
Published: 14 Dec 2022
README
opam-publish
A tool to ease contributions to opam repositories.
opam-publish
takes package definition files of your projects, and submits them to opam package repositories (ocaml/opam-repository by default).
Prerequisites
This version is for opam 2.0.0, and should not be used with repositories in older formats. A Github account is required. opam repository is cloned over ssh, you need to have your ssh keys registered in your Github account.
Usage
Basic case, assuming your project is on Github
The same works for initial publications, new releases, and updates.
The following should be run from the source directory of your project
Make sure you have an
opam
file, orNAME.opam
files at the root of your projectCreate a tag:
git tag -a TAG; git push origin TAG
Run
opam publish
. This will install the tool if required.
You will be guided through the rest (creating a Github token the first time, reviewing the patch, etc.)
Additional possibilities
If your project is not on Github, you can specify the archive URL on the command-line.
If the opam files are not in the archive, or outdated, you can specify them on the command-line, or specify a directory where to look for them (e.g. opam publish URL .
).
Submitting to other repositories is possible, as long as they are on Github. See the --repo
option.
Updating already published packages is also allowed (as long as they don't use a files/
subdirectory)..
See opam publish --help
for more options.
Dependencies (9)
-
github-unix
>= "4.3.2"
-
github
>= "4.3.2"
-
opam-state
>= "2.1.0~rc" & < "2.2"
-
opam-format
>= "2.1.0~rc" & < "2.2"
-
opam-core
>= "2.1.0~rc" & < "2.2"
-
ocaml
>= "4.03.0"
- lwt_ssl
-
dune
>= "1.0"
-
cmdliner
>= "1.1.0"
Dev Dependencies
None
Used by (3)
-
dune-release
< "0.2.0"
-
publish
>= "0.3.4+transition"
-
spectrum
< "0.2.0"
Conflicts (1)
-
ssl
= "0.5.6"