zeronsd/docs/release.md

Cutting a release

If any of this doesn't work, alert @erikh immediately.

• Run make clean and let it run as root.
• Edit Cargo.toml to update the version string near the top of the file.
• Put a token attached to a central instance into test-token.txt. This file is in .gitignore and should not be attached to networks you care about.
• make test-integration. This will create and join your host to several networks.
• make test-packages. Read the output to ensure it passes.
• Commit and push main: git commit -a -s -m "zeronsd v<version>" && git push <remote> main
• Tag git: git tag v<version>. The v is important here. Delete the tag if you created a non-v tag.
• Push the tag: git push <remote> v<version>
• Publish any cargo subpackages (e.g., the openapi client libraries).
• Push cargo: cargo publish. (Get @erikh involved if you need to)
• Push docker image: docker push zerotier/zeronsd:<version> -- no v in the version here.
• Tag latest docker image and push it: docker tag zerotier/zeronsd:<version> zerotier/zeronsd:latest && docker push zerotier/zeronsd:latest
• Edit the release tag, it'll be here.
  • In the target directory, there will be several files. Push them to the release.
    • zeronsd_*.deb is for debian/ubuntu systems.
    • zeronsd-*.rpm is for RedHat systems.
• Windows: Start up a windows VM. You should have the following tools:
  • Rust Compiler -- note that this yields an unsigned binary. Just install it, wimp.
    • Follow the printed instructions on getting the C++ runtime. You will need it.
    • If cargo doesn't work after this, you've done it wrong.
  • WIX Toolset also needs to be installed.
  • Finally, set up some kind of clone of the tag, or VM shared folders.
  • Run cargo wix in an administrator terminal.
    • The resulting installer will be in target/wix/*.msi. You do not need the other files.
• OS X: Get permissions from Joseph to commit to homebrew-tap or submit a PR.
  • Edit Formula/zeronsd.rb and change the following attributes:
    • version
    • git SHA
  • Commit it and run make test-packages. This will test the installation of your package on linuxbrew and mac homebrew.