diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index 8cfe3f06b3..e35520127f 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -37,14 +37,14 @@ jobs: strategy: matrix: os: [macOS-latest, ubuntu-latest] - agda: ['2.6.3'] + agda: ['2.6.4'] steps: - name: Checkout our repository uses: actions/checkout@v3 with: path: master - name: Setup Agda - uses: wenkokke/setup-agda@v2.0.0 + uses: wenkokke/setup-agda@v2.1.0 with: agda-version: ${{ matrix.agda }} diff --git a/.github/workflows/pages.yaml b/.github/workflows/pages.yaml index c18615cbc2..b8c8c6b82f 100644 --- a/.github/workflows/pages.yaml +++ b/.github/workflows/pages.yaml @@ -27,7 +27,7 @@ jobs: runs-on: macOS-latest strategy: matrix: - agda: ['2.6.3'] + agda: ['2.6.4'] environment: name: github-pages url: ${{ steps.deployment.outputs.page_url }} @@ -44,7 +44,7 @@ jobs: fetch-depth: 0 - name: Setup Agda - uses: wenkokke/setup-agda@v2.0.0 + uses: wenkokke/setup-agda@v2.1.0 with: agda-version: ${{ matrix.agda }} diff --git a/HOME.md b/HOME.md index a62ee328b3..22935d7e51 100644 --- a/HOME.md +++ b/HOME.md @@ -17,7 +17,7 @@ potential to be useful, and informative resources for both working and learning mathematicians. Our library is designed to work towards this goal, and we welcome contributions to the library within any topic in mathematics. -The `agda-unimath` library is compatible with Agda 2.6.3 and can be compiled by +The `agda-unimath` library is compatible with Agda 2.6.4 and can be compiled by running `make check` from the root directory of the repository. Learn more about using the library locally in our [installation guide](HOWTO-INSTALL.md). diff --git a/HOWTO-INSTALL.md b/HOWTO-INSTALL.md index a0eb4d04f2..5826c33cc3 100644 --- a/HOWTO-INSTALL.md +++ b/HOWTO-INSTALL.md @@ -5,7 +5,7 @@ ### Quick setup To work or experiment with the `agda-unimath` library on your machine, you will -need to have `agda` version 2.6.3 installed, and a suitable editor such as +need to have `agda` version 2.6.4 installed, and a suitable editor such as [Emacs](https://www.gnu.org/software/emacs/) or [Visual Studio Code](https://code.visualstudio.com/). The following instructions will help you on your way right away: @@ -122,7 +122,7 @@ working branches when necessary. ## Installing Agda {#installing-agda} -The `agda-unimath` library is built and verified with Agda 2.6.3, and we provide +The `agda-unimath` library is built and verified with Agda 2.6.4, and we provide two methods for installation: with or without the package manager [Nix](https://nixos.org/). Nix streamlines the installation of Agda and its dependencies, providing a consistent and reproducible environment for the @@ -130,7 +130,7 @@ library across different systems. ### Without Nix -To install Agda 2.6.3 without Nix, follow the +To install Agda 2.6.4 without Nix, follow the [installation guide](https://agda.readthedocs.io/en/latest/getting-started/installation.html) provided on the Agda documentation page. diff --git a/flake.lock b/flake.lock index 4166676b45..8f4f0d5187 100644 --- a/flake.lock +++ b/flake.lock @@ -21,7 +21,7 @@ "mdbook-catppuccin": { "inputs": { "nixpkgs": [ - "nixpkgs" + "nixpkgs-mdbook" ] }, "locked": { @@ -40,6 +40,22 @@ } }, "nixpkgs": { + "locked": { + "lastModified": 1699725108, + "narHash": "sha256-NTiPW4jRC+9puakU4Vi8WpFEirhp92kTOSThuZke+FA=", + "owner": "NixOS", + "repo": "nixpkgs", + "rev": "911ad1e67f458b6bcf0278fa85e33bb9924fed7e", + "type": "github" + }, + "original": { + "owner": "NixOS", + "ref": "nixpkgs-unstable", + "repo": "nixpkgs", + "type": "github" + } + }, + "nixpkgs-mdbook": { "locked": { "lastModified": 1696526028, "narHash": "sha256-Psqo4j/KNvpk45MKscqdYk/N5lmrLKIV8x4ednfiqnY=", @@ -50,8 +66,8 @@ }, "original": { "owner": "NixOS", - "ref": "nixpkgs-unstable", "repo": "nixpkgs", + "rev": "7fdd1421774a52277fb56d64b26aaf7765e1b3fa", "type": "github" } }, @@ -59,7 +75,8 @@ "inputs": { "flake-utils": "flake-utils", "mdbook-catppuccin": "mdbook-catppuccin", - "nixpkgs": "nixpkgs" + "nixpkgs": "nixpkgs", + "nixpkgs-mdbook": "nixpkgs-mdbook" } }, "systems": { diff --git a/flake.nix b/flake.nix index 2862fe4892..7ae3597968 100644 --- a/flake.nix +++ b/flake.nix @@ -2,20 +2,25 @@ description = "agda-unimath"; inputs = { - # Unstable is needed for Agda 2.6.3, latest stable 22.11 only has 2.6.2.2 + # Unstable is needed for Agda 2.6.4, latest stable 23.05 only has 2.6.3 nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable"; flake-utils.url = "github:numtide/flake-utils"; + # Nixpkgs with tested versions of mdbook crates; + # may be removed once we backport new mdbook assets to our + # modified versions + nixpkgs-mdbook.url = "github:NixOS/nixpkgs?rev=7fdd1421774a52277fb56d64b26aaf7765e1b3fa"; mdbook-catppuccin = { url = "github:catppuccin/mdBook/v1.2.0"; - inputs.nixpkgs.follows = "nixpkgs"; + inputs.nixpkgs.follows = "nixpkgs-mdbook"; }; }; - outputs = { self, nixpkgs, flake-utils, mdbook-catppuccin }: + outputs = { self, nixpkgs, nixpkgs-mdbook, flake-utils, mdbook-catppuccin }: flake-utils.lib.eachDefaultSystem (system: let pkgs = nixpkgs.legacyPackages."${system}"; + pkgs-mdbook = nixpkgs-mdbook.legacyPackages."${system}"; python = pkgs.python38.withPackages (p: with p; [ # Keep in sync with scripts/requirements.txt # pre-commit <- not installed as a Python package but as a binary below @@ -67,17 +72,16 @@ packages = [ # maintanance scripts python - # working on the website - pkgs.mdbook - pkgs.mdbook-katex - pkgs.mdbook-pagetoc - pkgs.mdbook-linkcheck - mdbook-catppuccin.packages."${system}".default # pre-commit checks pkgs.pre-commit - ]; + ] ++ (with pkgs-mdbook; [ + # working on the website + mdbook + mdbook-katex + mdbook-pagetoc + mdbook-linkcheck + mdbook-catppuccin.packages."${system}".default + ]); }; - - devShell = self.devShells."${system}".default; }); }