package opam-publish

Build not checked
  1. Overview
  2. Docs
A tool to ease contributions to opam repositories

Install

dune-project
 Dependency

Authors

Maintainers

Sources

2.0.0.tar.gz
md5=9a030e2c3083744e378f42791ec007e9
sha512=cf427e808aaa2da6270f916567158509d5669dbfa7d66abce203a8699e2744ac210e20dcd150aa07b8ac346439d942246fc874952583d54d98002076db6c15e0

Description

Opam-publish helps gather metadata to form an OPAM package and submit it to a remote repository.

Tags

flags:plugin

Added to opam-repository:

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.

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

  1. Make sure you have an opam file, or NAME.opam files at the root of your project
  2. Create a tag: git tag -a TAG; git push origin TAG
  3. 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 (10)

  1. github-unix build & >= "3.0.0" & < "4.3.0"
  2. github build & >= "2.0.0" & < "3.0.0"
  3. tls < "1.0.0"
  4. ssl
  5. cmdliner build & < "2.0.0"
  6. jbuilder >= "1.0+beta19"
  7. opam-state build & >= "2.0.0" & < "2.1"
  8. opam-format build & >= "2.0.0" & < "2.1"
  9. opam-core build & >= "2.0.0" & < "2.1"
  10. ocaml >= "4.02.3"

Dev Dependencies

None

Optional Dependencies

None

Used by (5)

  1. awskit
  2. dune-release < "0.2.0"
  3. oktree
  4. publish
  5. spectrum < "0.2.0" | >= "0.7.0"

Conflicts

None

Build status

Results of building opam-publish with each compiler on check.ci.ocaml.org, run of against opam-repository 78c202b. All results for this package.

Each result links to its build log. To keep crawlers from overloading the site, build logs require a GitHub sign-in (see ocurrent/opam-health-check). On your first log, GitHub asks you to “Authorize opam-health-check”, the OCurrent app that runs these checks; it sees only your public profile, not your repositories. The sign-in lasts 30 days.

This version is not in the latest run; the versions below are.

Version OCaml 4.11 OCaml 4.14 OCaml 5.2 OCaml 5.4 OCaml 5.5
3.0.1 good good good good good
  • good Package successfully built
  • partial One of the dependencies failed to build
  • bad Package failed to build
  • n/a Package is not available in this environment
  • internal Internal failure