release.md

Releasing a new version of styx

Themes update

1. Manually update the themes in themes/rev.csv

2. Generate the theme version hashes

   $ ./scripts/update-themes-hashes

3. Update the documentation

   ./scripts/update-doc

Styx

1. Write release notes in src/doc/release-notes.adoc

2. Run the tests

   nix flake check

3. Make a commit, and tag it with vVERSION, eg: v0.5.0

   $ git add .
   $ git commit
   $ git tag "vVERSION"
   $ git push HEAD origin --tag

nixpkgs

1. Updating the styx expression and test that it works:

   $ $(nix-build -A styx --no-out-link)/bin/styx preview-theme showcase

2. Submit a pull request to nixpkgs

3. wait until at least one unstable channel with styx gets updated, and make a release note in the styx-site

Announcements

1. Update the latest tag in the styx repo

   $ git tag "latest" --force
   $ git push origin HEAD --tag --force

2. Update the themes demo sites, run the following in the themes repo

   $ ./scripts/demo-sites

3. Make a post on the styx official site announcing the release

4. Done