wip: Feat/manpages

.github/workflows/CD.yml

@@ -32,15 +32,15 @@ jobs:
         with:
           rust-version: stable
       - uses: actions/checkout@v1
-      - name: Build
-        run: ci/action.sh release ${{ matrix.target }}
       - name: Get the version
         id: get_version
         run: echo ::set-output name=VERSION::${GITHUB_REF/refs\/tags\//}
+      - name: Build
+        run: ci/action.sh release ${{ matrix.target }} ${{ steps.get_version.outputs.VERSION }}
       - name: Upload binaries to release
         uses: svenstaro/upload-release-action@v1-release
         with:
           repo_token: ${{ secrets.GITHUB_TOKEN }}
           file: target/tar/bombadil.tar.gz
           tag: ${{ github.ref }}
-          asset_name: bombadil-${{ steps.get_version.outputs.VERSION }}-${{ matrix.target }}.tar.gz
+          asset_name: bombadil-${{ steps.get_version.outputs.VERSION }}-${{ matrix.target }}.tar.gz

ci/action.sh

@@ -10,6 +10,7 @@ echoerr() {
 release() {
 
    TAR_DIR="${BOMBADIL_HOME}/target/tar"
+   VERSION="$2"
 
    target="${1:-}"
    if [[ $target == *"osx"* ]]; then
@@ -30,6 +31,8 @@ release() {
       bin_folder="release"
    fi
 
+   ."/$BOMBADIL_HOME/ci/build_manpage.sh" -i man/bombadil.1.md -o "$TAR_DIR/bombadil.1" -v "$VERSION"
+
    bin_path="${BOMBADIL_HOME}/target/${bin_folder}/bombadil"
    chmod +x "$bin_path"
    mkdir -p "$TAR_DIR" 2> /dev/null || true
@@ -44,4 +47,4 @@ release() {
 cmd="$1"
 shift
 
-release "$@"
+release "$@"

ci/build_manpage.sh

@@ -0,0 +1,26 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+TEMP_FILE=/tmp/bombadil_man.md
+DATE=$(date +"%dth %B, %Y")
+
+while getopts v:i:o: option
+do
+case "${option}"
+in
+v) VERSION=${OPTARG};;
+i) INPUT_PATH=${OPTARG};;
+o) OUTPUT_PATH=${OPTARG};;
+*) echo "invalid flag"
+esac
+done
+
+echo -e "Creating temporary file"
+cp "$INPUT_PATH" "$TEMP_FILE"
+
+echo -e "Setting version to $VERSION"
+sed -i -e "s/{{version}}/$VERSION/g" "$TEMP_FILE"
+echo -e "Setting date released to $DATE"
+sed -i -e "s/{{date_released}}/$DATE/g" "$TEMP_FILE"
+
+pandoc "$TEMP_FILE" -s -t man > "$OUTPUT_PATH"

man/bombadil.1.md

@@ -0,0 +1,30 @@
+% BOMBADIL(1) bombadil {{version}}
+% Paul Delafosse
+% {{date_released}}
+
+# NAME
+
+bombadil - dotfile manager written in rust.
+
+# SYNOPSYS
+
+**bombadil** [*COMMAND*]
+
+# DESCRIPTION 
+
+**bombadil** blablabla
+
+# OPTIONS
+
+**-h** | **--help**
+: Displays a friendly help message
+
+**-V** | **--versions**
+: Displays version information
+
+# EXAMPLES
+
+**bombadil install -c .dotfiles/bombadil.toml**
+: Setup bombadi to use .dotfiles/bombadil.toml as its configuration file
+
+