Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dfinity/vessel-package-set

The official community package-set for vessel
https://github.com/dfinity/vessel-package-set

Last synced: about 1 month ago
JSON representation

The official community package-set for vessel

Awesome Lists containing this project

README

        

# Vessel Package Set · [![GitHub license](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![CI](https://img.shields.io/github/actions/workflow/status/dfinity/vessel-package-set/ci.yml?branch=master&logo=github)](https://github.com/dfinity/vessel-package-set/actions?query=workflow:"build") [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/dfinity/vessel-package-set/pulls)

The official community package-set for Motoko libraries to use with [vessel](https://github.com/dfinity/vessel).

## What is a package set?

A package set is a collection of packages in which there is only one specified version for each package in the set.

This means that when you want to install a package:
- it must be in the package set
- its dependencies and all the transitive dependencies must be in the package set

## Add your package

This repository aims to be a good collection of packages you can depend on.
In general we welcome all packages, provided that they follow some guidelines defined in the [contributing guide](CONTRIBUTING.md).

The linked document also contains instructions on how to add new packages to the set, and information on versioning and related policies.

## How do I use this with `vessel`?

You should point the `package-set.dhall` file in your project at a tagged release of this repository. For example:
```
let upstream =
https://github.com/dfinity/vessel-package-set/releases/download/mo-0.7.5-20230118/package-set.dhall
in upstream
```

## Attribution

Much of this machinery and documentation is adapted from https://github.com/purescript/package-sets.