Merge branch 'release-0.2.x'

This commit is contained in:
Zhaofeng Li 2021-11-18 16:16:13 -08:00
commit de397dfc60
4 changed files with 33 additions and 10 deletions

View file

@ -24,7 +24,7 @@ jobs:
authToken: '${{ secrets.CACHIX_AUTH_TOKEN }}' authToken: '${{ secrets.CACHIX_AUTH_TOKEN }}'
- name: Check API version - name: Check API version
run: echo "api_version=$(nix eval .#colmena.apiVersion)" >> $GITHUB_ENV run: echo "api_version=$(nix eval .#colmena.apiVersion | sed 's|\"||g')" >> $GITHUB_ENV
# == Manual # == Manual
- name: Build manual - name: Build manual
@ -51,7 +51,7 @@ jobs:
# Ugly hack so it has permission to delete the worktree afterwards # Ugly hack so it has permission to delete the worktree afterwards
- name: Copy redirect farm - name: Copy redirect farm
run: cp --no-preserve=mode -r out-redirectFarm/ redirect-farm/ run: cp --no-preserve=mode -r out-redirectFarm/ redirect-farm/
if: ${{ success() }} if: ${{ env.api_version == env.LATEST_STABLE_API }}
- name: Deploy redirect farm - name: Deploy redirect farm
uses: JamesIves/github-pages-deploy-action@4.1.5 uses: JamesIves/github-pages-deploy-action@4.1.5
@ -59,4 +59,4 @@ jobs:
branch: gh-pages branch: gh-pages
folder: redirect-farm folder: redirect-farm
target-folder: stable target-folder: stable
if: ${{ success() }} if: ${{ env.api_version == env.LATEST_STABLE_API }}

View file

@ -1,6 +1,7 @@
# Colmena # Colmena
[![Manual](https://img.shields.io/badge/Manual-Unstable-informational)](https://zhaofengli.github.io/colmena/unstable) [![Stable Manual](https://img.shields.io/badge/Manual-Stable-informational)](https://zhaofengli.github.io/colmena/stable)
[![Unstable Manual](https://img.shields.io/badge/Manual-Unstable-orange)](https://zhaofengli.github.io/colmena/unstable)
[![Build](https://github.com/zhaofengli/colmena/workflows/Build/badge.svg)](https://github.com/zhaofengli/colmena/actions/workflows/build.yml) [![Build](https://github.com/zhaofengli/colmena/workflows/Build/badge.svg)](https://github.com/zhaofengli/colmena/actions/workflows/build.yml)
Colmena is a simple, stateless [NixOS](https://nixos.org) deployment tool modeled after [NixOps](https://github.com/NixOS/nixops) and [morph](https://github.com/DBCDK/morph), written in Rust. Colmena is a simple, stateless [NixOS](https://nixos.org) deployment tool modeled after [NixOps](https://github.com/NixOS/nixops) and [morph](https://github.com/DBCDK/morph), written in Rust.
@ -24,8 +25,15 @@ $ <b>colmena apply --on @tag-a</b>
## Installation ## Installation
Colmena doesn't have a stable release yet. To install the latest stable version to the user profile, use the following command:
To install the latest development version to the user profile, use the following command:
```bash
nix-env -if https://github.com/zhaofengli/colmena/tarball/stable
```
### Unstable Version
To install the latest development version:
```bash ```bash
nix-env -if https://github.com/zhaofengli/colmena/tarball/main nix-env -if https://github.com/zhaofengli/colmena/tarball/main
@ -37,8 +45,6 @@ Alternatively, if you have a local clone of the repo:
nix-env -if default.nix nix-env -if default.nix
``` ```
### Unstable Binary Cache
A public binary cache is available at https://colmena.cachix.org, courtesy of Cachix. A public binary cache is available at https://colmena.cachix.org, courtesy of Cachix.
This binary cache contains unstable versions of Colmena built by [GitHub Actions](https://github.com/zhaofengli/colmena/actions). This binary cache contains unstable versions of Colmena built by [GitHub Actions](https://github.com/zhaofengli/colmena/actions).

View file

@ -3,7 +3,19 @@
## Installation ## Installation
<!-- STABLE_BEGIN --> <!-- STABLE_BEGIN -->
Colmena doesn't have a stable release yet. To quickly try Colmena out, use the following command to enter an ephemeral environment with the latest stable version of `colmena`:
```bash
nix shell github:zhaofengli/colmena/stable
```
To install Colmena to the user profile, use the following command:
```bash
nix-env -if https://github.com/zhaofengli/colmena/tarball/stable
```
You can also add `github:zhaofengli/colmena/stable` as an input in your Flake and add the `colmena` package to your `devShell`.
If you are interested in trying out the bleeding-edge version of Colmena, Read [the unstable version](https://zhaofengli.github.io/colmena/unstable) of the Manual for instructions. If you are interested in trying out the bleeding-edge version of Colmena, Read [the unstable version](https://zhaofengli.github.io/colmena/unstable) of the Manual for instructions.
<!-- STABLE_END --> <!-- STABLE_END -->

View file

@ -3,7 +3,12 @@
## Installation ## Installation
<!-- STABLE_BEGIN --> <!-- STABLE_BEGIN -->
Colmena doesn't have a stable release yet.
To install the latest stable version to the user profile, use the following command:
```bash
nix-env -if https://github.com/zhaofengli/colmena/tarball/stable
```
If you are interested in trying out the bleeding-edge version of Colmena, Read [the unstable version](https://zhaofengli.github.io/colmena/unstable) of the Manual for instructions. If you are interested in trying out the bleeding-edge version of Colmena, Read [the unstable version](https://zhaofengli.github.io/colmena/unstable) of the Manual for instructions.
<!-- STABLE_END --> <!-- STABLE_END -->