Merge pull request #63 from afh/web-docs

Build documentation using nix for CI

Author: afh

.github/workflows/build_and_deploy.yml

@@ -1,46 +1,56 @@
-name: Build and Deploy
-
+name: Build and Deploy static content to GitHub Pages
 on:
-  workflow_dispatch:
   push:
-    branches: [ "master" ]
+    branches: master
   pull_request:
-    branches: [ "master" ]
+    branches: master
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
 
-permissions:
-  contents: read
+# Allow one concurrent deployment
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
 
 jobs:
-  build_and_deploy:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: cachix/install-nix-action@v20
+        with:
+          nix_path: nixpkgs=channel:nixos-unstable
+      - name: Build website
+        run: |
+          mkdir -p build
+          nix build .
+          cp -R result/* build
+      - name: Build documentation
+        run: |
+          mkdir -p build/doc
+          nix build .#doc-ledger
+          cp result/share/doc/ledger/ledger* build/doc
+          nix build .#doc-ledger-mode
+          cp result/ledger-mode.* build/doc
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
+        with:
+          path: 'build'
+
+  deploy:
+    if: ${{ github.ref == 'refs/heads/master' }}
+    needs: build
+    permissions:
+      contents: read
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
-    - name: Install dependencies
-      run: |
-        sudo apt-get update;
-        sudo apt-get install --yes \
-          texinfo groff \
-          texlive-base texlive-fonts-recommended texlive-plain-generic
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: 2.7
-        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
-    - name: Build website
-      run: bundle exec middleman build
-    - name: Build documentation
-      run: make docs
-    - name: Deploy
-      if: ${{ github.ref == 'refs/heads/master' }}
-      env:
-        AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
-        AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
-      uses: reggionick/s3-deploy@v3
-      with:
-        folder: build
-        bucket: ${{ vars.AWS_S3_BUCKET }}
-        bucket-region: ${{ vars.AWS_S3_BUCKET_REGION }}
-        delete-removed: true
-        no-cache: true
-        private: true
-        filesToInclude: ".*/*,*/*,**"
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2

.gitignore

@@ -7,5 +7,7 @@ _*
 snapshot.tar.gz
 *.log
 *.aes
+.DS_Store
+result*
 vendor/
 .bundle/

CNAME

@@ -0,0 +1 @@
+www.ledger-cli.org

Gemfile.lock

@@ -10,7 +10,7 @@ GEM
       public_suffix (>= 2.0.2, < 6.0)
     autoprefixer-rails (10.4.13.0)
       execjs (~> 2)
-    backports (3.23.0)
+    backports (3.24.0)
     coffee-script (2.4.1)
       coffee-script-source
       execjs

Makefile

@@ -9,7 +9,7 @@ CURL    := curl --silent --location
 
 OWNER   := ledger
 REPO    := ledger
-LATEST  := $(shell curl -sqI -w '%{redirect_url}\n' -o /dev/null https://github.com/$(OWNER)/$(REPO)/releases/latest | rev | cut -d/ -f1 | rev)
+LATEST  := $(shell curl -sqI -w '%{redirect_url}\n' -o /dev/null https://github.com/$(OWNER)/$(REPO)/releases/latest | awk -F/ '{print $$NF}' )
 
 HOST                       := https://raw.githubusercontent.com
 ledger3.texi_repopath      := $(OWNER)/$(REPO)/$(LATEST)/doc

flake.lock

@@ -0,0 +1,102 @@
+{
+  description = "Website for ledger-cli.org";
+
+  nixConfig.bash-prompt = "ledger-cli.org$ ";
+
+  inputs = {
+    nixpkgs.url = "nixpkgs/nixpkgs-unstable";
+    flake-utils.url = "github:numtide/flake-utils";
+    # NOTA BENE: When a new release of ledger or ledger-mode is available, update
+    # the tag in the url below and run `nix flake update`, so that GitHub Actions
+    # will build the documentation from the latest ledger and ledger-mode release.
+    # TODO: Replace `master` with the tag of the ledger release following 3.3.1, once available.
+    ledger.url = "github:ledger/ledger/master";
+    ledger-mode.url = "github:ledger/ledger-mode/v4.0.0";
+    ledger-mode.flake = false;
+  };
+
+  outputs = { self, nixpkgs, flake-utils, ledger, ledger-mode }:
+    flake-utils.lib.eachDefaultSystem( system:
+    let
+      pkgs = import nixpkgs { inherit system; };
+      gems = with pkgs; bundlerEnv {
+        name = "ledger.github.io-gems";
+        inherit ruby;
+        gemdir = ./.;
+      };
+      tex = with pkgs; texlive.combine {
+        inherit (texlive) collection-plaingeneric collection-fontsrecommended;
+      };
+    in
+    {
+      packages = rec {
+        default = website;
+        website = pkgs.stdenvNoCC.mkDerivation rec {
+          name = "ledger.github.io";
+          src = self;
+
+          dontConfigure = true;
+
+          nativeBuildInputs = with pkgs; [ gems ruby nodejs ];
+
+          buildPhase = ''
+            runHook preBuild
+            bundle exec middleman build
+            runHook postBuild
+          '';
+
+          installPhase = ''
+            runHook preInstall
+            mv build $out
+            runHook postInstall
+          '';
+        };
+
+       doc-ledger = pkgs.stdenvNoCC.mkDerivation rec {
+         name = "ledger";
+
+         src = ledger;
+
+         nativeBuildInputs = with pkgs; [
+           cmake groff texinfo tex
+         ];
+
+         enableParallelBuilding = false;
+
+         preConfigure = "cd doc";
+
+         cmakeFlags = [ "-DBUILD_WEB_DOCS:BOOL=ON" "-Wno-dev" ];
+
+         buildFlags = "doc";
+       };
+
+       doc-ledger-mode = pkgs.stdenvNoCC.mkDerivation rec {
+         name = "ledger-mode";
+
+         src = ledger-mode;
+         nativeBuildInputs = with pkgs; [
+           texinfo tex
+         ];
+
+         enableParallelBuilding = false;
+
+         dontConfigure = true;
+
+         preBuild = "cd doc";
+         buildPhase = ''
+           runHook preBuild
+           texi2pdf --batch ledger-mode.texi
+           makeinfo --force --html --no-split ledger-mode.texi
+           runHook postBuild
+         '';
+
+         installPhase = ''
+           runHook preInstall
+           mkdir -p $out
+           cp ledger-mode.html ledger-mode.pdf $out/
+           runHook postInstall
+         '';
+       };
+      };
+    });
+}