Skip to content

Latest commit

 

History

History
63 lines (38 loc) · 3.23 KB

README.md

File metadata and controls

63 lines (38 loc) · 3.23 KB

ipfs-repo

ipfs.tech Discuss codecov CI

The repo and migration tools used by IPFS

Table of contents

Structure

Development

  1. Clone this repo
  2. Run npm install

This will install lerna and bootstrap the various packages, deduping and hoisting dependencies into the root folder.

If later you wish to remove all the node_modules/dist folders and start again, run npm run reset && npm install from the root.

See the scripts section of the root package.json for more commands.

Publishing new versions

  1. Ensure you have a GH_TOKEN env var containing a GitHub Personal Access Token with public_repo permissions
  2. From the root of this repo run npm run release and follow the on screen prompts. It will use conventional commits to work out the new package version

Using prerelease versions

Any changed packages from each successful build of master are published to npm as canary builds under the npm tag next.

Canary builds only consider changes to packages in the last built commit so changes to the root config files should not result in new prereleases being published to npm.

License

Licensed under either of

Contribute

Contributions welcome! Please check out the issues.

Also see our contributing document for more information on how we work, and about contributing in general.

Please be aware that all interactions related to this repo are subject to the IPFS Code of Conduct.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.