https://github.com/ocaml-ppx/ppx_import
Less redundancy in type declarations and signatures
https://github.com/ocaml-ppx/ppx_import
Last synced: 9 months ago
JSON representation
Less redundancy in type declarations and signatures
- Host: GitHub
- URL: https://github.com/ocaml-ppx/ppx_import
- Owner: ocaml-ppx
- License: mit
- Created: 2014-08-01T15:34:11.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2024-11-12T15:47:38.000Z (about 1 year ago)
- Last Synced: 2025-03-29T12:09:48.148Z (10 months ago)
- Language: OCaml
- Size: 820 KB
- Stars: 89
- Watchers: 7
- Forks: 29
- Open Issues: 17
-
Metadata Files:
- Readme: README.dev.md
- Changelog: CHANGES.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-list - ppx_import - ppx | 74 | (OCaml)
- awesome-ocaml - ppx_import
README
Welcome to ppx_import, and thanks for willing to contribute to its
development.
## How to release a new version of ppx_import
**Quick release instructions:** Run `git tag -a` + `dune-release`.
The preferred workflow to release `ppx_import` is to use
`dune-release`.
The first (and most important) step is to tag the release and push it
to the main repository.
We recommend you do this manually. As `dune-release` uses `git
describe` to gather versioning information, your tag must be
annotated. Using `git tag -a` or `git tag -s` will do the job. Please
add the version changes to the tag annotation message.
You can also use `dune-release tag`, which will try to infer the
tag information from `CHANGES.md`, however the current heuristics
seem too fragile and the changes list may not be properly updated.
Once the tag is in place, calling `dune-release` will build, lint, run
the tests, create the opam package, upload the archives and
docs to the release page, and submit a pull request to the OPAM
repository.
Under the hood, `dune-release` executes the following 4 commands:
```
dune-release distrib # Create the distribution archive
dune-release publish # Publish it on the WWW with its documentation
dune-release opam pkg # Create an opam package
dune-release opam submit # Submit it to OCaml's opam repository
```
It is often useful to run the commands separately as to have better
control of the release process.
Note that you will need the proper permissions for the `publish` step,
including setting a Github access token, see `dune-release help
files` for more information.