Merge branch 'main' into chore/use-dynamic-url

catppuccin · May 20, 2024 · 40d4eb9 · 40d4eb9
2 parents 0a214ef + 87a5f92
commit 40d4eb9
Show file tree

Hide file tree

Showing 26 changed files with 1,170 additions and 18,364 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -0,0 +1,35 @@
+name: "Generate test artifacts"
+
+on:
+  pull_request:
+    types: [opened, reopened, synchronize]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          submodules: true
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+          cache: "pip"
+      - name: Install dependencies
+        run: pip install -r requirements.txt
+      - name: Install colloid specific dependencies
+        run: sudo apt update && sudo apt install -y sassc inkscape optipng
+      - name: Generate themes
+        run: |
+          python patches/xfwm4/generate_assets.py
+
+          python ./build.py mocha --all-accents --zip -d $PWD/releases &&
+          python ./build.py macchiato --all-accents --zip -d $PWD/releases &&
+          python ./build.py frappe --all-accents --zip -d $PWD/releases &&
+          python ./build.py latte --all-accents --zip -d $PWD/releases
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: '${{ github.sha }}-artifacts'
+          path: ./releases/*.zip
+
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -1,4 +1,4 @@
-name: "Release"
+name: "Mainline release"
 
 on:
   push:
@@ -22,10 +22,10 @@ jobs:
         run: sudo apt update && sudo apt install -y sassc inkscape optipng
       - name: Generate themes
         run: |
-          python ./build.py mocha -a all --zip -d $PWD/releases &&
-          python ./build.py macchiato -a all --zip -d $PWD/releases &&
-          python ./build.py frappe -a all --zip -d $PWD/releases &&
-          python ./build.py latte -a all --zip -d $PWD/releases
+          python ./build.py mocha --all-accents --zip -d $PWD/releases &&
+          python ./build.py macchiato --all-accents --zip -d $PWD/releases &&
+          python ./build.py frappe --all-accents --zip -d $PWD/releases &&
+          python ./build.py latte --all-accents --zip -d $PWD/releases
       - name: Add zips to release
         uses: softprops/action-gh-release@v2
         with:

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -17,4 +17,24 @@ Once the build script patches the submodule, it will write a file into
 The palette patches are generated through `whiskers`,
 so if you're changing them, they will need regenerated. Simply run `whiskers palette.tera` to rebuild them.
 
-The process for building the theme is [documented in the README](./README.md#building).
+The process for building the theme is [documented in the README](./README.md#building).
+
+### Running test builds
+We support building and publishing test builds from PRs. When you open PRs, the CI will automatically build with your changes and push an artifact
+which bundles all of the produced themes.
+
+You can then download the artifacts as a zip (result should look similar to 7bff2448a81e36bf3b0e03bfbd649bebe6973ec7-artifacts.zip) and
+pass the path into `install.py` under the `--from-artifact` option:
+```bash
+python3 install.py mocha blue --dest ./build --from-artifact ~/downloads/7bff2448a81e36bf3b0e03bfbd649bebe6973ec7-artifacts.zip
+```
+
+This will take the target flavor / accent out of the zip, and install it using the regular install process. 
+
+It is advised to pass a `--dest` when running in this mode, because the released zips follow the exact same naming scheme as regular builds.
+This wil cause conflicts when you install, if you already had that theme installed. Passing a different destination allows you to move the 
+extracted folders to `~/.local/share/themes` yourself, adding a suffix as appropriate to avoid conflicts.
+
+> [!WARNING]
+> If you pass `--link` to the install script when working from a PR, it will forcibly overwrite your `~/.config/gtk-4.0/` symlinks.
+> You will have to reinstall / relink to revert this.
diff --git a/README.md b/README.md
@@ -1,14 +1,14 @@
 <h3 align="center">
-	<img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/logos/exports/1544x1544_circle.png" width="100" alt="Logo"/><br/>
-	<img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/misc/transparent.png" height="30" width="0px"/>
-	Catppuccin for <a href="https://gtk.org/">GTK</a>
-	<img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/misc/transparent.png" height="30" width="0px"/>
+  <img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/logos/exports/1544x1544_circle.png" width="100" alt="Logo"/><br/>
+  <img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/misc/transparent.png" height="30" width="0px"/>
+  Catppuccin for <a href="https://gtk.org/">GTK</a>
+  <img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/misc/transparent.png" height="30" width="0px"/>
 </h3>
 
 <p align="center">
-    <a href="https://github.com/catppuccin/gtk/stargazers"><img src="https://img.shields.io/github/stars/catppuccin/gtk?colorA=363a4f&colorB=b7bdf8&style=for-the-badge"></a>
-    <a href="https://github.com/catppuccin/gtk/issues"><img src="https://img.shields.io/github/issues/catppuccin/gtk?colorA=363a4f&colorB=f5a97f&style=for-the-badge"></a>
-    <a href="https://github.com/catppuccin/gtk/contributors"><img src="https://img.shields.io/github/contributors/catppuccin/gtk?colorA=363a4f&colorB=a6da95&style=for-the-badge"></a>
+  <a href="https://github.com/catppuccin/gtk/stargazers"><img src="https://img.shields.io/github/stars/catppuccin/gtk?colorA=363a4f&colorB=b7bdf8&style=for-the-badge"></a>
+  <a href="https://github.com/catppuccin/gtk/issues"><img src="https://img.shields.io/github/issues/catppuccin/gtk?colorA=363a4f&colorB=f5a97f&style=for-the-badge"></a>
+  <a href="https://github.com/catppuccin/gtk/contributors"><img src="https://img.shields.io/github/contributors/catppuccin/gtk?colorA=363a4f&colorB=a6da95&style=for-the-badge"></a>
 </p>
 
 <p align="center">
@@ -17,22 +17,24 @@
 
 This GTK theme is based on the [Colloid](https://github.com/vinceliuice/Colloid-gtk-theme) theme made by [vinceliuice](https://github.com/vinceliuice)
 
-
 ## Installation
+
 This GTK theme requires:
-- GTK >=3.20
+
+- GTK `>=3.20`
 - Python 3+
 
 ### Automated script
+
 We provide a Python script to automate the process of installing the theme:
 
-```
+```bash
 curl -LsS "https://raw.githubusercontent.com/catppuccin/gtk/main/install.py" -o install.py
 python3 install.py <flavor> <accent>
   [catppuccin-gtk] [INFO] - Installation info:
       flavor:     mocha
       accent:     blue
-      dest:       /home/****/.local/share/themes
+      dest:       /home/<user>/.local/share/themes
       link:       False
 
       remote_url: https://github.com/catppuccin/gtk/releases/download/v1.0.0-alpha/catppuccin-mocha-blue-standard+default.zip
@@ -47,68 +49,77 @@ python3 install.py <flavor> <accent>
 ```
 
 ### Arch Linux
-  With your favourite AUR helper, you can install your theme of choice:
 
-  ```bash
-  yay -S catppuccin-gtk-theme-<flavor>
-  paru -S catppuccin-gtk-theme-<flavor>
-  ```
+With your favourite AUR helper, you can install your flavor of choice:
+
+```bash
+yay -S catppuccin-gtk-theme-<flavor>
+paru -S catppuccin-gtk-theme-<flavor>
+```
 
 ### Nix
-  We have created a Nix module ([catppuccin/nix](https://github.com/catppuccin/nix)) for theming apps under Nix, and recommend that you use it.
-  You can set up our Nix module for GTK with the following config:
-  ```nix
-  {inputs, ...}: {
-    imports = [inputs.catppuccin.homeManagerModules.catppuccin];
 
-    gtk = {
+We have created a Nix module ([catppuccin/nix](https://github.com/catppuccin/nix)) for theming apps under Nix, and recommend that you use it.
+You can set up our Nix module for GTK with the following config:
+
+```nix
+{inputs, ...}: {
+  imports = [inputs.catppuccin.homeManagerModules.catppuccin];
+  gtk = {
+    enable = true;
+    catppuccin = {
       enable = true;
-      catppuccin = {
-        enable = true;
-        flavor = "mocha";
-        accent = "pink";
-        size = "standard";
-        tweaks = [ "normal" ];
-      };
+      flavor = "mocha";
+      accent = "pink";
+      size = "standard";
+      tweaks = [ "normal" ];
     };
-  }
-  ```
-  > [!TIP]
-  > For further information on the options available with our module, see the [full documentation](https://github.com/catppuccin/nix/blob/main/docs/home-manager-options.md#gtkcatppuccinenable).
-
-  Alternatively, if you are not using our Nix module, you can grab the theme from [nixpkgs/catppuccin-gtk](https://github.com/NixOS/nixpkgs/blob/master/pkgs/data/themes/catppuccin-gtk/default.nix)
+  };
+}
+```
 
-### Manual installation
-  If your distro does not package our theme, and the installation script will not work for your use case, you can pull down releases and extract them yourself. You can find the [latest release on GitHub](https://github.com/catppuccin/gtk/releases/latest).
+> [!TIP]
+> For further information on the options available with our module, see the [full documentation](https://github.com/catppuccin/nix/blob/main/docs/home-manager-options.md#gtkcatppuccinenable).
 
-  ```bash
-  cd ~/.local/share/themes
+Alternatively, if you are not using our Nix module, you can grab the theme from [nixpkgs/catppuccin-gtk](https://github.com/NixOS/nixpkgs/blob/master/pkgs/data/themes/catppuccin-gtk/default.nix)
 
-  local ROOT_URL="https://https://github.com/catppuccin/gtk/releases/download"
+### Manual installation
 
-  # Change to the tag you want to download
-  local RELEASE = "v1.0.0"
-
-  # Change to suite your flavor / accent combination
-  local FLAVOR = "mocha"
-  local ACCENT = "mauve"
-  curl -LsS "${ROOT_URL}/${RELEASE}/catppuccin-${FLAVOR}-${ACCENT}-standard+default.zip"
+If your distro does not package our theme, and the installation script will not work for your use case, you can pull down releases and extract them yourself. You can find the [latest release on GitHub](https://github.com/catppuccin/gtk/releases/latest).
 
-  unzip catppuccin-${FLAVOR}-${ACCENT}-standard+default.zip
+```bash
+cd ~/.local/share/themes
 
-  export THEME_DIR="~/.local/share/themes/catppuccin-${FLAVOR}-${ACCENT}-standard+default"
+# Set the root URL
+export ROOT_URL="https://https://github.com/catppuccin/gtk/releases/download"
 
-  # Optionally, add support for libadwaita
-  mkdir -p "${HOME}/.config/gtk-4.0" && 
-  ln -sf "${THEME_DIR}/gtk-4.0/assets" "${HOME}/.config/gtk-4.0/assets" &&
-  ln -sf "${THEME_DIR}/gtk-4.0/gtk.css" "${HOME}/.config/gtk-4.0/gtk.css" &&
-  ln -sf "${THEME_DIR}/gtk-4.0/gtk-dark.css" "${HOME}/.config/gtk-4.0/gtk-dark.css"
-  ```
+# Change to the tag you want to download
+export RELEASE="v1.0.0"
+
+# Change to suite your flavor / accent combination
+export FLAVOR="mocha"
+export ACCENT="mauve"
+curl -LsS "${ROOT_URL}/${RELEASE}/catppuccin-${FLAVOR}-${ACCENT}-standard+default.zip"
+
+# Extract the catppuccin zip file
+unzip catppuccin-${FLAVOR}-${ACCENT}-standard+default.zip
+
+# Set the catppuccin theme directory
+export THEME_DIR="~/.local/share/themes/catppuccin-${FLAVOR}-${ACCENT}-standard+default"
+
+# Optionally, add support for libadwaita
+mkdir -p "${HOME}/.config/gtk-4.0" && 
+ln -sf "${THEME_DIR}/gtk-4.0/assets" "${HOME}/.config/gtk-4.0/assets" &&
+ln -sf "${THEME_DIR}/gtk-4.0/gtk.css" "${HOME}/.config/gtk-4.0/gtk.css" &&
+ln -sf "${THEME_DIR}/gtk-4.0/gtk-dark.css" "${HOME}/.config/gtk-4.0/gtk-dark.css"
+```
 
 ## Building
+
 If our prebuilt offerings do not match your requirements, you will have to build the theme from source.
 
 ### Requirements
+
 - Python 3+
 - `sassc`, the Sass compiler
 
@@ -117,6 +128,7 @@ If our prebuilt offerings do not match your requirements, you will have to build
 > with `git clone <url> --recurse-submodules` to bring in the submodule.
 
 To build the theme, simply invoke `build.py`:
+
 ```bash
 python3 build.py mocha --dest ./build -a rosewater --tweaks rimless
   [catppuccin-gtk] [INFO] - Patches seem to be applied, remove "colloid/.patched" to force application (this may fail)