Skip to content

Latest commit

 

History

History
67 lines (42 loc) · 2.19 KB

dev.md

File metadata and controls

67 lines (42 loc) · 2.19 KB
Raw

Development docs

How to update the website

To update https://input-output-hk.github.io/cardano-launcher/, run the update-gh-pages script:

./scripts/update-gh-pages.sh
git push origin gh-pages

How to make a release

Release checklist:

  1. Bump version in package.json and package-lock.json, open PR, merge.
  2. Check that Buildkite and GitHub actions for master branch are green.
  3. Check that all PRs have labels (for release notes generation).
  4. Run ./scripts/tag-release.sh.
  5. git push origin VERSION
  6. Create a new draft release containing the contents of release-notes-VERSION.md. Edit the text according to taste.
  7. Gather release approvals then publish the GitHub release.
  8. Check that the GitHub actions "release" workflow runs correctly.

After publishing the GitHub release, there should be a new NPM version created, and the website should be updated with the latest docs from the released version.

How to update the cardano-wallet and cardano-node versions

Use the niv tool. To get it, run nix-shell. Then:

niv update cardano-wallet

This will use the branches configuration in nix/sources.json. Niv also provides options for choosing another branch or git rev.

cardano-node

The cardano-node version is set by cardano-wallet. To temporarily override this version, add a source, using something like:

niv add local $HOME/iohk/cardano-node

Once this is set, nix-shell should report trace: Note: using cardano-node from ....

When finished, remove the source override with:

niv drop cardano-node

cardano-node configurations for tests

Before running tests, ensure that you have the BYRON_CONFIGS environment pointing to the configuration subdirectory of the cardano-node repo.

If running in a nix-shell, the BYRON_CONFIGS variable is set automatically.

If running under Windows Powershell, do:

$Env:BYRON_CONFIGS = "E:\cardano-node\configuration"

How to set up windows for testing

See the Windows page on the wiki.