trmnl_preview 0.21.0 → 0.22.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1b736ce74a0385dda5b989fe604d0256d0b1522b1955855aa0eac945ec3dd0b
-  data.tar.gz: f4b4321d72bd9129a025f07d21707f0584e965a5bfe072db3ecc95c2fbf04921
+  metadata.gz: abbaf54f1f6ccdb3a4b76b1be3d43b574a74c06f63c59e493c4a1b7e2a409bc3
+  data.tar.gz: 4275a70d54b9456786a149bbc43ff778357e06d99bc70be516b89bdf240c1509
 SHA512:
-  metadata.gz: 3997799add0b42fd60ffd8f6c7d9d3c99696152fe32316e8925cfe1a24eed73f410a7efc86a432a46697d1fbd7fa0fa44c7d8c63727c48c0ff48778035e993f5
-  data.tar.gz: 12cf46d3ae00fda1f1e82eb80c5ed2bbe2598208ad84de9ecdc878afcb96b51f27e4ed62630195cdb1a0fc60a8d5b6cbc1d6be2f1ef4833aefdc0c370cd1634d
+  metadata.gz: 3931b0a7a91a3f2c8fc1eafc72211a799bf980baa7575fb1af1000fe1666b8e846acc6af68a50107349d7e887d46c0b5d01a67be535682c5f5844be43decd050
+  data.tar.gz: 1318426dd6a23949218f826bb4cdcb926914856f4f00447eb5b3a18565c496ab2920e1b5bf06e7952b3ccf578204108834ec3a5b789f98404f9f58d1b71b2cee

data/CHANGELOG.md

@@ -1,6 +1,14 @@
 
 # Changelog
 
+## 0.22.1
+
+- The Docker image runs liquid 5.14 and selenium-webdriver 4.50, as TRMNL does. It had 5.13 and 4.48, so Liquid output could differ from TRMNL. Installs of the gem already took the newer versions.
+
+## 0.22.0
+
+- The `bin/trmnlp` script that `trmnlp init` writes takes the steps that run the Docker image from the image, once a day, so a fix to them reaches every plugin with the image. Before, each plugin kept its own copy, which changed only when `trmnlp init` ran again. A plugin made before this release gets the new script from `trmnlp init <its folder>`, answering `y` for `bin/trmnlp` only, once.
+
 ## 0.21.0
 
 - The `bin/trmnlp` script that `trmnlp init` writes pulls a newer `trmnl/trmnlp` image once a day, so a Docker user stays on the latest release. Before, it ran whatever image was pulled first. The README shows how to install the script as `trmnlp` with Docker alone.

data/README.md

@@ -253,9 +253,10 @@ docker run --rm --entrypoint cat trmnl/trmnlp /app/templates/init/bin/trmnlp > ~
 chmod +x ~/.local/bin/trmnlp
 ```
 
-It runs each command in the image and pulls a newer image once a day. To stay on one release,
-set `IMAGE` in the script to a tag such as `trmnl/trmnlp:v0.20.0`. `trmnlp init` puts the same
-script in each plugin as `bin/trmnlp`.
+It runs each command in the image and pulls a newer image once a day. The steps that run the image
+come from the image too, so the script itself does not go out of date. To stay on one release, set
+`IMAGE` in the script to a tag such as `trmnl/trmnlp:v0.22.0` (v0.22.0 or later). `trmnlp init` puts
+the same script in each plugin as `bin/trmnlp`.
 
 Or run the image yourself:
 
@@ -549,6 +550,16 @@ To cut a release:
 
 By convention, add a matching `CHANGELOG.md` entry in the same change.
 
+## Related guides
+
+- [Private Plugins](https://help.trmnl.com/en/articles/9510536-private-plugins): strategies, polling and webhooks
+- [Liquid 101](https://help.trmnl.com/en/articles/10671186-liquid-101) and the [Framework Design Docs](https://help.trmnl.com/en/articles/12410486-framework-design-docs)
+- [Custom plugin form builder](https://help.trmnl.com/en/articles/10513740-custom-plugin-form-builder): the form fields `src/settings.yml` declares
+- [Syncing Plugins with GitHub](https://help.trmnl.com/en/articles/13465101-syncing-plugins-with-github) and [GitHub Sync](https://help.trmnl.com/en/articles/15977899-github-sync)
+- [Recipe best practices](https://help.trmnl.com/en/articles/11395668-recipe-best-practices) and [Demo Data for Publishing Plugins](https://help.trmnl.com/en/articles/12772238-demo-data-for-publishing-plugins)
+- [TRMNL CLI](https://help.trmnl.com/en/articles/17226209-trmnl-cli): the rest of your account from the terminal
+- [MCP Server](https://help.trmnl.com/en/articles/17432548-mcp-server) and our [agent skills](https://github.com/usetrmnl/trmnl-agent-skills): build plugins with an AI agent
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/usetrmnl/trmnlp.

data/lib/trmnlp/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TRMNLP
-  VERSION = '0.21.0'
+  VERSION = '0.22.1'
 end

data/templates/init/bin/trmnlp

@@ -4,6 +4,9 @@
 # Use this opportunity to set up environment variables, install dependencies, etc.
 #
 
+# Add a tag to stay on one release, v0.22.0 or later: trmnl/trmnlp:v0.22.0
+IMAGE=trmnl/trmnlp
+
 # Saved on the PATH as `trmnlp`, this script is what `command -v trmnlp` finds: not a gem.
 GEM="$(command -v trmnlp)"
 if [ -n "$GEM" ] && ! [ "$GEM" -ef "$0" ]
@@ -23,71 +26,25 @@ Or install Docker:
     exit 1
 fi
 
-# Determine XDG config directory on host OS
-if [ -n "$XDG_CONFIG_HOME" ]; then
-    CONFIG_DIR="$XDG_CONFIG_HOME/trmnlp"
-else
-    CONFIG_DIR="$HOME/.config/trmnlp"
-fi
-
-# What trmnlp caches is kept as well: a plugin's OAuth tokens, its saved data and transform state.
+# The steps that run the image live in the image, so this copy in the plugin never goes out of date.
+# Once a day a newer image is pulled and those steps are taken from it. With no network, the image
+# already here is used.
 CACHE_DIR="${XDG_CACHE_HOME:-$HOME/.cache}/trmnl"
-
-mkdir -p "$CONFIG_DIR" "$CACHE_DIR"
-
-# Add a tag to stay on one release: trmnl/trmnlp:v0.20.0
-IMAGE=trmnl/trmnlp
-
-# A newer release is pulled once a day. With no network, the image already here runs.
-PULLED_AT="$CACHE_DIR/image_pulled"
-if [ -z "$(find "$PULLED_AT" -mtime -1 2> /dev/null)" ]; then
+RUN_IN_DOCKER="$CACHE_DIR/run_in_docker/${IMAGE//[^a-zA-Z0-9._-]/_}"
+if [ -z "$(find "$RUN_IN_DOCKER" -mtime -1 2> /dev/null)" ]; then
+    mkdir -p "$(dirname "$RUN_IN_DOCKER")"
     docker pull --quiet "$IMAGE" > /dev/null 2>&1
-    touch "$PULLED_AT"
-fi
-
-# On Linux the container's root is the host's root, and the files trmnlp writes (snapshots, _build,
-# a pulled plugin) would be root's. So trmnlp runs as you, with a home of its own to write in.
-# Docker Desktop and rootless Docker hand the files to you already.
-CONTAINER_HOME=/root
-SECURITY="$(docker info --format '{{.SecurityOptions}}' 2> /dev/null)"
-if [ "$(uname)" = Linux ] && [ "$(id -u)" != 0 ] && [ -n "$SECURITY" ] && [[ "$SECURITY" != *rootless* ]]
-then
-    CONTAINER_HOME=/tmp/home
-    # .config and .cache are made for you as well: Docker would make them root's to mount the
-    # folders below into them, and Firefox hangs when it cannot write there.
-    ARGS=(
-        --user "$(id -u):$(id -g)"
-        --env HOME=/tmp/home
-        --tmpfs "/tmp/home:exec,uid=$(id -u),gid=$(id -g)"
-        --tmpfs "/tmp/home/.config:uid=$(id -u),gid=$(id -g)"
-        --tmpfs "/tmp/home/.cache:exec,uid=$(id -u),gid=$(id -g)"
-    )
+    if docker run --rm --entrypoint cat "$IMAGE" /app/templates/run_in_docker > "$RUN_IN_DOCKER.$$" 2> /dev/null
+    then
+        mv "$RUN_IN_DOCKER.$$" "$RUN_IN_DOCKER"
+    else
+        rm -f "$RUN_IN_DOCKER.$$"
+    fi
 fi
 
-# A terminal only when there is one: CI and scripts have none.
-if [ -t 0 ] && [ -t 1 ]; then
-    ARGS+=(--tty)
-fi
-
-# Only serve listens, so every other command can run next to it.
-if [ "$1" = serve ]; then
-    PORT=4567
-    for ARG in "$@"; do
-        case "$PREVIOUS" in -p | --port) PORT="$ARG" ;; esac
-        case "$ARG" in --port=*) PORT="${ARG#--port=}" ;; esac
-        PREVIOUS="$ARG"
-    done
-    ARGS+=(--publish "$PORT:$PORT")
+if ! [ -s "$RUN_IN_DOCKER" ]; then
+    echo "Could not run $IMAGE. Check that Docker is running and that the image is v0.22.0 or later."
+    exit 1
 fi
 
-exec docker run \
-    --rm \
-    --init \
-    --interactive \
-    "${ARGS[@]}" \
-    --env CI \
-    --env TRMNL_API_KEY \
-    --volume "$CONFIG_DIR:$CONTAINER_HOME/.config/trmnlp" \
-    --volume "$CACHE_DIR:$CONTAINER_HOME/.cache/trmnl" \
-    --volume "$(pwd):/plugin" \
-    "$IMAGE" "$@"
+IMAGE="$IMAGE" exec bash "$RUN_IN_DOCKER" "$@"

data/templates/run_in_docker

@@ -0,0 +1,66 @@
+#!/usr/bin/env bash
+#
+# Runs a trmnlp command in the Docker image. The bin/trmnlp script that `trmnlp init` writes takes
+# this file from the image once a day, so a fix here reaches every plugin with the image.
+#
+
+IMAGE="${IMAGE:-trmnl/trmnlp}"
+
+# Determine XDG config directory on host OS
+if [ -n "$XDG_CONFIG_HOME" ]; then
+    CONFIG_DIR="$XDG_CONFIG_HOME/trmnlp"
+else
+    CONFIG_DIR="$HOME/.config/trmnlp"
+fi
+
+# What trmnlp caches is kept as well: a plugin's OAuth tokens, its saved data and transform state.
+CACHE_DIR="${XDG_CACHE_HOME:-$HOME/.cache}/trmnl"
+
+mkdir -p "$CONFIG_DIR" "$CACHE_DIR"
+
+# On Linux the container's root is the host's root, and the files trmnlp writes (snapshots, _build,
+# a pulled plugin) would be root's. So trmnlp runs as you, with a home of its own to write in.
+# Docker Desktop and rootless Docker hand the files to you already.
+CONTAINER_HOME=/root
+SECURITY="$(docker info --format '{{.SecurityOptions}}' 2> /dev/null)"
+if [ "$(uname)" = Linux ] && [ "$(id -u)" != 0 ] && [ -n "$SECURITY" ] && [[ "$SECURITY" != *rootless* ]]
+then
+    CONTAINER_HOME=/tmp/home
+    # .config and .cache are made for you as well: Docker would make them root's to mount the
+    # folders below into them, and Firefox hangs when it cannot write there.
+    ARGS=(
+        --user "$(id -u):$(id -g)"
+        --env HOME=/tmp/home
+        --tmpfs "/tmp/home:exec,uid=$(id -u),gid=$(id -g)"
+        --tmpfs "/tmp/home/.config:uid=$(id -u),gid=$(id -g)"
+        --tmpfs "/tmp/home/.cache:exec,uid=$(id -u),gid=$(id -g)"
+    )
+fi
+
+# A terminal only when there is one: CI and scripts have none.
+if [ -t 0 ] && [ -t 1 ]; then
+    ARGS+=(--tty)
+fi
+
+# Only serve listens, so every other command can run next to it.
+if [ "$1" = serve ]; then
+    PORT=4567
+    for ARG in "$@"; do
+        case "$PREVIOUS" in -p | --port) PORT="$ARG" ;; esac
+        case "$ARG" in --port=*) PORT="${ARG#--port=}" ;; esac
+        PREVIOUS="$ARG"
+    done
+    ARGS+=(--publish "$PORT:$PORT")
+fi
+
+exec docker run \
+    --rm \
+    --init \
+    --interactive \
+    "${ARGS[@]}" \
+    --env CI \
+    --env TRMNL_API_KEY \
+    --volume "$CONFIG_DIR:$CONTAINER_HOME/.config/trmnlp" \
+    --volume "$CACHE_DIR:$CONTAINER_HOME/.cache/trmnl" \
+    --volume "$(pwd):/plugin" \
+    "$IMAGE" "$@"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trmnl_preview
 version: !ruby/object:Gem::Version
-  version: 0.21.0
+  version: 0.22.1
 platform: ruby
 authors:
 - Rockwell Schrock
@@ -502,6 +502,7 @@ files:
 - templates/init/src/shared.liquid
 - templates/init/src/transform.py.example
 - templates/init/tests/plugin_spec.rb
+- templates/run_in_docker
 - trmnl_preview.gemspec
 - web/public/highlight/highlight.min.js
 - web/public/highlight/styles/atom-one-dark.min.css