Update Docs

smashedr · smashedr · commit f38ab9b82e64 · 2025-11-22T15:42:03.000-08:00
diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml
@@ -19,15 +19,22 @@ jobs:
     timeout-minutes: 5
 
     steps:
+      - name: "Checkout"
+        uses: actions/checkout@v5
+
+      - name: "Debug event.json"
+        continue-on-error: true
+        run: cat "${GITHUB_EVENT_PATH}"
+
       - name: "Debug CTX github"
-        if: ${{ !github.event.act }}
         continue-on-error: true
         env:
           GITHUB_CTX: ${{ toJSON(github) }}
         run: echo "$GITHUB_CTX"
 
-      - name: "Checkout"
-        uses: actions/checkout@v5
+      - name: "Debug Environment"
+        continue-on-error: true
+        run: env
 
       - name: "Setup Python 3.13"
         uses: actions/setup-python@v6
diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml
@@ -4,6 +4,12 @@ on:
   workflow_dispatch:
   push:
     branches: [master]
+    paths-ignore:
+      - ".gitignore"
+      - ".prettierignore"
+      - "build.ps1"
+      - "MANIFEST.in"
+      - "pyproject.toml"
   pull_request:
 
 concurrency:
@@ -24,19 +30,16 @@ jobs:
         uses: actions/checkout@v5
 
       - name: "Debug event.json"
-        if: ${{ !github.event.act }}
         continue-on-error: true
         run: cat "${GITHUB_EVENT_PATH}"
 
       - name: "Debug CTX github"
-        if: ${{ !github.event.act }}
         continue-on-error: true
         env:
           GITHUB_CTX: ${{ toJSON(github) }}
         run: echo "$GITHUB_CTX"
 
       - name: "Debug Environment"
-        if: ${{ !github.event.act }}
         continue-on-error: true
         run: env
 
diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
@@ -31,20 +31,27 @@ jobs:
       url: ${{ env.url }}
 
     steps:
-      - name: "Debug"
-        run: |
-          echo "github.ref_name: ${{ github.ref_name }}"
-          echo "name: ${{ github.event.release.prerelease && 'test' || 'pypi' }}"
-          echo "env.url: ${{ env.url }}"
-          echo "env.repository-url: ${{ env.repository-url }}"
+      - name: "Debug event.json"
+        continue-on-error: true
+        run: cat "${GITHUB_EVENT_PATH}"
 
       - name: "Debug CTX github"
-        if: ${{ !github.event.act }}
         continue-on-error: true
         env:
           GITHUB_CTX: ${{ toJSON(github) }}
         run: echo "$GITHUB_CTX"
 
+      #- name: "Debug Environment"
+      #  continue-on-error: true
+      #  run: env
+
+      - name: "Debug"
+        run: |
+          echo "github.ref_name: ${{ github.ref_name }}"
+          echo "name: ${{ github.event.release.prerelease && 'test' || 'pypi' }}"
+          echo "env.url: ${{ env.url }}"
+          echo "env.repository-url: ${{ env.repository-url }}"
+
       - name: "Download Artifact"
         uses: actions/download-artifact@v6
         with:
diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml
@@ -15,17 +15,15 @@ on:
 jobs:
   build:
     name: "Build"
+    if: ${{ !contains(github.event.head_commit.message, '#notest') }}
     uses: ./.github/workflows/build.yaml
     with:
       name: test
-    #permissions:
-    #  contents: write
 
   test:
     runs-on: ubuntu-latest
     timeout-minutes: 5
     needs: [build]
-    if: ${{ !contains(github.event.head_commit.message, '#notest') }}
     strategy:
       fail-fast: false
       matrix:
@@ -50,10 +48,10 @@ jobs:
           GITHUB_CTX: ${{ toJSON(github) }}
         run: echo "$GITHUB_CTX"
 
-      #- name: "Debug Environment"
-      #  if: ${{ !github.event.act }}
-      #  continue-on-error: true
-      #  run: env
+      - name: "Debug Environment"
+        if: ${{ !github.event.act }}
+        continue-on-error: true
+        run: env
 
       - name: "Download Artifact"
         uses: actions/download-artifact@v6
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
+# Generic
 .idea/
 *.iml
 .vscode/
@@ -11,6 +12,8 @@ dist/
 *.pyc
 .coverage
 coverage.xml
+# Zensical
 site/
 .cache/
+# App
 output.txt
diff --git a/README.md b/README.md
@@ -2,6 +2,7 @@
 [![GitHub Release Version](https://img.shields.io/github/v/release/cssnr/actions-tools?logo=github)](https://github.com/cssnr/actions-tools/releases)
 [![TOML Python Version](https://img.shields.io/badge/dynamic/toml?url=https%3A%2F%2Fraw.githubusercontent.com%2Fcssnr%2Factions-tools%2Frefs%2Fheads%2Fmaster%2Fpyproject.toml&query=%24.project.requires-python&logo=python&logoColor=white&label=python)](https://github.com/cssnr/actions-tools?tab=readme-ov-file#readme)
 [![PyPI Downloads](https://img.shields.io/pypi/dm/actions-tools?logo=pypi&logoColor=white)](https://pypistats.org/packages/actions-tools)
+[![Pepy Total Downloads](https://img.shields.io/pepy/dt/actions-tools?logo=pypi&logoColor=white&label=total)](https://clickpy.clickhouse.com/dashboard/actions-tools)
 [![Codecov](https://codecov.io/gh/cssnr/actions-tools/graph/badge.svg?token=A8NDHZ393X)](https://codecov.io/gh/cssnr/actions-tools)
 [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=cssnr_actions-tools&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=cssnr_actions-tools)
 [![Workflow Test](https://img.shields.io/github/actions/workflow/status/cssnr/actions-tools/test.yaml?logo=cachet&label=test)](https://github.com/cssnr/actions-tools/actions/workflows/test.yaml)
@@ -13,7 +14,7 @@
 [![GitHub Repo Size](https://img.shields.io/github/repo-size/cssnr/actions-tools?logo=bookstack&logoColor=white&label=repo%20size)](https://github.com/cssnr/actions-tools)
 [![GitHub Top Language](https://img.shields.io/github/languages/top/cssnr/actions-tools?logo=htmx&logoColor=white)](https://github.com/cssnr/actions-tools?tab=readme-ov-file#readme)
 [![GitHub Contributors](https://img.shields.io/github/contributors-anon/cssnr/actions-tools?logo=github)](https://github.com/cssnr/actions-tools/graphs/contributors)
-[![GitHub Discussions](https://img.shields.io/github/discussions/cssnr/cloudflare-purge-cache-action?logo=github)](https://github.com/cssnr/cloudflare-purge-cache-action/discussions)
+[![GitHub Discussions](https://img.shields.io/github/discussions/cssnr/actions-tools?logo=github)](https://github.com/cssnr/actions-tools/discussions)
 [![GitHub Forks](https://img.shields.io/github/forks/cssnr/actions-tools?style=flat&logo=github)](https://github.com/cssnr/actions-tools/forks)
 [![GitHub Repo Stars](https://img.shields.io/github/stars/cssnr/actions-tools?style=flat&logo=github)](https://github.com/cssnr/actions-tools/stargazers)
 [![GitHub Org Stars](https://img.shields.io/github/stars/cssnr?style=flat&logo=github&label=org%20stars)](https://cssnr.github.io/)
@@ -151,7 +152,7 @@ core.is_debug()
 # https://pygithub.readthedocs.io/en/stable/
 token = core.get_input("token", True)
 g = core.get_github(token)
-repo = g.get_repo(f"{context.repository}")
+repo = g.get_repo(context.repository)
 core.info(f"repo.name: {repo.name}")
 
 # OIDC Token
diff --git a/docs/actions.md b/docs/actions.md
@@ -4,6 +4,8 @@ icon: simple/githubactions
 
 # :simple-githubactions: Actions
 
+[![Actions Tools](https://raw.githubusercontent.com/smashedr/repo-images/refs/heads/master/actions-tools/logo128.png){ align=right width=96 }](https://github.com/cssnr/actions-tools?tab=readme-ov-file#readme)
+
 I have also developed quite a few [GitHub Actions](https://actions.cssnr.com/actions).
 
 - https://actions.cssnr.com/
diff --git a/docs/index.md b/docs/index.md
@@ -4,17 +4,18 @@ icon: lucide/rocket
 
 # :lucide-rocket: Get Started
 
-[![Image title](https://raw.githubusercontent.com/smashedr/repo-images/refs/heads/master/actions-tools/logo128.png){ align=right }](https://github.com/cssnr/actions-tools?tab=readme-ov-file#readme)
+[![Actions Tools](https://raw.githubusercontent.com/smashedr/repo-images/refs/heads/master/actions-tools/logo128.png){ align=right width=96 }](https://github.com/cssnr/actions-tools?tab=readme-ov-file#readme)
 
 [![PyPI Version](https://img.shields.io/pypi/v/actions-tools?logo=pypi&logoColor=white&label=pypi)](https://pypi.org/project/actions-tools/)
-[![GitHub Release Version](https://img.shields.io/github/v/release/cssnr/actions-tools?logo=github)](https://github.com/cssnr/actions-tools/releases)
 [![TOML Python Version](https://img.shields.io/badge/dynamic/toml?url=https%3A%2F%2Fraw.githubusercontent.com%2Fcssnr%2Factions-tools%2Frefs%2Fheads%2Fmaster%2Fpyproject.toml&query=%24.project.requires-python&logo=python&logoColor=white&label=python)](https://github.com/cssnr/actions-tools?tab=readme-ov-file#readme)
 [![PyPI Downloads](https://img.shields.io/pypi/dm/actions-tools?logo=pypi&logoColor=white)](https://pypistats.org/packages/actions-tools)
+[![Pepy Total Downloads](https://img.shields.io/pepy/dt/actions-tools?logo=pypi&logoColor=white&label=total)](https://clickpy.clickhouse.com/dashboard/actions-tools)
+[![Workflow Test](https://img.shields.io/github/actions/workflow/status/cssnr/actions-tools/test.yaml?logo=cachet&label=test)](https://github.com/cssnr/actions-tools/actions/workflows/test.yaml)
 [![Codecov](https://codecov.io/gh/cssnr/actions-tools/graph/badge.svg?token=A8NDHZ393X)](https://codecov.io/gh/cssnr/actions-tools)
 [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=cssnr_actions-tools&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=cssnr_actions-tools)
-[![GitHub Top Language](https://img.shields.io/github/languages/top/cssnr/actions-tools?logo=htmx&logoColor=white)](https://github.com/cssnr/actions-tools?tab=readme-ov-file#readme)
 [![GitHub Last Commit](https://img.shields.io/github/last-commit/cssnr/actions-tools?logo=github&logoColor=white&label=updated)](https://github.com/cssnr/actions-tools/graphs/commit-activity)
-[![GitHub Repo Size](https://img.shields.io/github/repo-size/cssnr/actions-tools?logo=bookstack&logoColor=white&label=repo%20size)](https://github.com/cssnr/actions-tools)
+[![GitHub Issues](https://img.shields.io/github/issues/cssnr/actions-tools?logo=github)](https://github.com/cssnr/actions-tools/issues)
+[![GitHub Discussions](https://img.shields.io/github/discussions/cssnr/actions-tools?logo=github)](https://github.com/cssnr/actions-tools/discussions)
 [![GitHub Forks](https://img.shields.io/github/forks/cssnr/actions-tools?style=flat&logo=github)](https://github.com/cssnr/actions-tools/forks)
 [![GitHub Repo Stars](https://img.shields.io/github/stars/cssnr/actions-tools?style=flat&logo=github&logoColor=white)](https://github.com/cssnr/actions-tools/stargazers)
 [![GitHub Org Stars](https://img.shields.io/github/stars/cssnr?style=flat&logo=github&label=org%20stars)](https://cssnr.github.io/)
@@ -131,7 +132,7 @@ from actions import core, context
 
 token = core.get_input("token", True)
 g = core.get_github(token)  # (1)!
-repo = g.get_repo(f"{context.repository}")
+repo = g.get_repo(context.repository)
 core.info(f"repo.name: {repo.name}")
 core.set_output("name", repo.name)
 core.summary.add_raw("🚀 We Did It!")
diff --git a/docs/support.md b/docs/support.md
@@ -4,7 +4,9 @@ icon: lucide/message-circle-question-mark
 
 # :lucide-message-circle-question-mark: Support
 
-If you run into any [issues](https://github.com/cssnr/actions-tools/issues),
+[![Actions Tools](https://raw.githubusercontent.com/smashedr/repo-images/refs/heads/master/actions-tools/logo128.png){ align=right width=96 }](https://github.com/cssnr/actions-tools?tab=readme-ov-file#readme)
+
+If you run into any [issues](https://github.com/cssnr/actions-tools/issues)
 want to see more [features](https://github.com/cssnr/actions-tools/discussions/categories/feature-requests)
 or just have a [question](https://github.com/cssnr/actions-tools/discussions/categories/q-a)
 please let us know.
diff --git a/docs/usage.md b/docs/usage.md
@@ -4,10 +4,14 @@ icon: lucide/notebook-pen
 
 # :lucide-notebook-pen: Usage
 
+[![Actions Tools](https://raw.githubusercontent.com/smashedr/repo-images/refs/heads/master/actions-tools/logo128.png){ align=right width=96 }](https://github.com/cssnr/actions-tools?tab=readme-ov-file#readme)
+
 After [installing](index.md) import the module and start using the methods...
 
 ## From actions/core
 
+These methods are similar to the JavaScript [actions/core](https://github.com/actions/toolkit/tree/main/packages/core#usage) Toolkit.
+
 Full `core` reference: [/src/actions/core.py](https://github.com/cssnr/actions-tools/blob/master/src/actions/core.py)
 
 ### Inputs
@@ -40,7 +44,7 @@ my_data = core.get_data("data")  # -> Any - from json or yaml
 
 ### Context
 
-This is a custom `object`: [/src/actions/context.py](https://github.com/cssnr/actions-tools/blob/master/src/actions/context.py)
+Full `context` reference: [/src/actions/context.py](https://github.com/cssnr/actions-tools/blob/master/src/actions/context.py)
 
 ```python
 from actions import core, context
@@ -227,7 +231,7 @@ token = core.get_input("token", True)
 
 g = core.get_github(token)  # (1)!
 
-repo = g.get_repo(f"{context.repository}")
+repo = g.get_repo(context.repository)
 core.info(f"repo.name: {repo.name}")
 ```
 
@@ -251,6 +255,8 @@ Reference: https://docs.github.com/en/actions/reference/security/oidc
 
 ## New In actions-tools
 
+These methods are new in actions-tools.
+
 ```python
 from actions import core, context
 
@@ -269,8 +275,12 @@ core.info("Indented")  # only works with core.info
 core.end_indent()
 ```
 
+Please [let us know](https://github.com/cssnr/actions-tools/discussions/categories/feature-requests) what **features** you want.
+
 ## Example Actions
 
+Example and Template Actions using [actions-tools](https://github.com/cssnr/actions-tools?tab=contributing-ov-file#readme).
+
 - Create Files Action: [cssnr/create-files-action/src/main.py](https://github.com/cssnr/create-files-action/blob/master/src/main.py)
 - Python Action Template: [smashedr/test-action-py/src/main.py](https://github.com/smashedr/test-action-py/blob/master/src/main.py)
 - Python UV Action Template: [smashedr/test-action-uv/src/main.py](https://github.com/smashedr/test-action-uv/blob/master/src/main.py)
diff --git a/zensical.toml b/zensical.toml
@@ -221,17 +221,17 @@ icon = "simple/githubactions"
 link = "https://actions.cssnr.com/"
 name = "Actions"
 [[project.extra.social]]
-icon = "fontawesome/solid/house-laptop"
-link = "https://cssnr.github.io/"
-name = "Website"
-[[project.extra.social]]
 icon = "fontawesome/brands/discord"
 link = "https://discord.gg/wXy6m2X8wY"
 name = "Discord"
 [[project.extra.social]]
 icon = "simple/kofi"
 link = "https://ko-fi.com/cssnr"
 name = "Ko-fi"
+[[project.extra.social]]
+icon = "fontawesome/solid/house-laptop"
+link = "https://cssnr.github.io/"
+name = "Website"
 
 [project.extra]
 generator = false
