Skip to content

Latest commit

 

History

History
114 lines (83 loc) · 3.32 KB

CONTRIBUTING.md

File metadata and controls

114 lines (83 loc) · 3.32 KB
Raw

Contributing

Setup your development environment

You need Esy, you can install the latest version from npm:

yarn global add esy@latest
# Or
npm install -g esy@latest

Then run the esy command from this project root to install and build depenencies.

esy

This project uses Dune as a build system, if you add a dependency in your package.json file, don't forget to add it to your dune and dune-project files too.

Running Binary

After building the project, you can run the main binary that is produced.

esy start

Running Tests

You can run the test compiled executable:

esy test

Building documentation

Documentation for the libraries in the project can be generated with:

esy doc
open-cli $(esy doc-path)

This assumes you have a command like open-cli installed on your system.

NOTE: On macOS, you can use the system command open, for instance open $(esy doc-path)

Releasing

To release prebuilt binaries to all platforms, we use Github Actions to build each binary individually.

The binaries are then uploaded to a Github Release and NPM automatically.

To trigger the Release workflow, you need to push a git tag to the repository. We provide a script that will bump the version of the project, tag the commit and push it to Github:

./script/release.sh

The script will release the current project version on Opam, update the documentation and push a new tag on Github.

Releasing

To create a release and publish it on Opam, first update the CHANGES.md file with the last changes and the version that you want to release. The, you can run the script script/release.sh. The script will perform the following actions:

  • Create a tag with the version found in reason-ls.opam, and push it to your repository.
  • Create the distribution archive.
  • Publish the distribution archive to a Github Release.
  • Submit a PR on Opam's repository.

When the release is published on Github, the CI/CD will trigger the Release workflow which will perform the following actions

  • Compile binaries for all supported platforms.
  • Create an NPM release containing the pre-built binaries.
  • Publish the NPM release to the registry.

Repository Structure

The following snippet describes reason-ls's repository structure.

.
├── .github/
|   Contains Github specific files such as actions definitions and issue templates.
│
├── bin/
|   Source for reason-ls's binary. This links to the library defined in `lib/`.
│
├── lib/
|   Source for reason-ls's library. Contains reason-ls's core functionnalities.
│
├── test/
|   Unit tests and integration tests for reason-ls.
│
├── dune-project
|   Dune file used to mark the root of the project and define project-wide parameters.
|   For the documentation of the syntax, see https://dune.readthedocs.io/en/stable/dune-files.html#dune-project
│
├── LICENSE
│
├── package.json
|   Esy package definition.
|   To know more about creating Esy packages, see https://esy.sh/docs/en/configuration.html.
│
├── README.md
│
└── reason-ls.opam
    Opam package definition.
    To know more about creating and publishing opam packages, see https://opam.ocaml.org/doc/Packaging.html.