From 33bea47a60ff29622e16773bcf0bb0d9eef91ba0 Mon Sep 17 00:00:00 2001 From: Shane <6071159+smashedr@users.noreply.github.com> Date: Sat, 29 Nov 2025 00:25:33 -0800 Subject: [PATCH] Update Workflows and Docs --- .gitattributes | 3 +++ .github/workflows/build.yaml | 8 ++++---- .github/workflows/dev.yaml | 1 + .github/workflows/docs.yaml | 2 ++ .github/workflows/labeler.yaml | 2 +- .github/workflows/lint.yaml | 3 +-- .github/workflows/release.yaml | 6 +++--- .github/workflows/test.yaml | 2 +- README.md | 5 +++-- docs/actions.md | 2 +- docs/index.md | 2 +- docs/javascripts/external-links.js | 12 ++++++++++++ docs/support.md | 12 ++++++------ docs/usage.md | 4 ++-- pyproject.toml | 5 +++++ zensical.toml | 23 +++-------------------- 16 files changed, 49 insertions(+), 43 deletions(-) create mode 100644 .gitattributes create mode 100644 docs/javascripts/external-links.js diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..5e0f547 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,3 @@ +docs/** linguist-documentation +docs.ps1 linguist-vendored +build.ps1 linguist-vendored diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml index 0325401..609e897 100644 --- a/.github/workflows/build.yaml +++ b/.github/workflows/build.yaml @@ -20,7 +20,7 @@ jobs: steps: - name: "Checkout" - uses: actions/checkout@v5 + uses: actions/checkout@v6 - name: "Debug event.json" continue-on-error: true @@ -32,9 +32,9 @@ jobs: GITHUB_CTX: ${{ toJSON(github) }} run: echo "$GITHUB_CTX" - #- name: "Debug Environment" - # continue-on-error: true - # run: env + - name: "Debug Environment" + continue-on-error: true + run: env - name: "Setup Python 3.13" uses: actions/setup-python@v6 diff --git a/.github/workflows/dev.yaml b/.github/workflows/dev.yaml index 94b3245..c681239 100644 --- a/.github/workflows/dev.yaml +++ b/.github/workflows/dev.yaml @@ -23,6 +23,7 @@ jobs: uses: cssnr/zensical-action@master with: upload: "artifact" + prepare: 'sed -i "s/>Zensical<\/a>/>Zensical<\/a> v${ZENSICAL_VERSION}/" zensical.toml' deploy: name: "Deploy" diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml index 0b81856..affb004 100644 --- a/.github/workflows/docs.yaml +++ b/.github/workflows/docs.yaml @@ -35,6 +35,8 @@ jobs: - name: "Zensical Action" id: zensical uses: cssnr/zensical-action@master + with: + prepare: 'sed -i "s/>Zensical<\/a>/>Zensical<\/a> v${ZENSICAL_VERSION}/" zensical.toml' - name: "Purge Cache" if: ${{ env.purge-domain != '' }} diff --git a/.github/workflows/labeler.yaml b/.github/workflows/labeler.yaml index 2f3c44d..6f280f5 100644 --- a/.github/workflows/labeler.yaml +++ b/.github/workflows/labeler.yaml @@ -19,7 +19,7 @@ jobs: steps: - name: "Checkout Configs" - uses: actions/checkout@v5 + uses: actions/checkout@v6 with: repository: cssnr/configs ref: master diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml index d291cd0..56fc135 100644 --- a/.github/workflows/lint.yaml +++ b/.github/workflows/lint.yaml @@ -27,7 +27,7 @@ jobs: steps: - name: "Checkout" - uses: actions/checkout@v5 + uses: actions/checkout@v6 - name: "Debug event.json" continue-on-error: true @@ -67,7 +67,6 @@ jobs: python -m pip list - name: "Debug" - if: ${{ !github.event.act }} continue-on-error: true run: | python -V diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index 07f6e0f..1d85cb9 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -41,9 +41,9 @@ jobs: GITHUB_CTX: ${{ toJSON(github) }} run: echo "$GITHUB_CTX" - #- name: "Debug Environment" - # continue-on-error: true - # run: env + - name: "Debug Environment" + continue-on-error: true + run: env - name: "Debug" run: | diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml index 3bc4ff4..b9afe09 100644 --- a/.github/workflows/test.yaml +++ b/.github/workflows/test.yaml @@ -34,7 +34,7 @@ jobs: steps: - name: "Checkout" - uses: actions/checkout@v5 + uses: actions/checkout@v6 - name: "Debug event.json" if: ${{ !github.event.act }} diff --git a/README.md b/README.md index 71d2261..b3e4077 100644 --- a/README.md +++ b/README.md @@ -8,8 +8,8 @@ [![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) [![Workflow Lint](https://img.shields.io/github/actions/workflow/status/cssnr/actions-tools/lint.yaml?logo=cachet&label=lint)](https://github.com/cssnr/actions-tools/actions/workflows/lint.yaml) [![Workflow Release](https://img.shields.io/github/actions/workflow/status/cssnr/actions-tools/release.yaml?logo=cachet&label=release)](https://github.com/cssnr/actions-tools/actions/workflows/release.yaml) -[![GitHub Deployments](https://img.shields.io/github/deployments/cssnr/actions-tools/pypi?logo=pypi&logoColor=white&label=pypi)](https://pypi.org/project/actions-tools/) -[![GitHub Deployments](https://img.shields.io/github/deployments/cssnr/actions-tools/docs?logo=materialformkdocs&logoColor=white&label=docs)](https://actions-tools.cssnr.com/) +[![Deployment PyPi](https://img.shields.io/github/deployments/cssnr/actions-tools/pypi?logo=pypi&logoColor=white&label=pypi)](https://pypi.org/project/actions-tools/) +[![Deployment Docs](https://img.shields.io/github/deployments/cssnr/actions-tools/docs?logo=materialformkdocs&logoColor=white&label=docs)](https://actions-tools.cssnr.com/) [![GitHub Last Commit](https://img.shields.io/github/last-commit/cssnr/actions-tools?logo=github&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 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) @@ -271,6 +271,7 @@ Additionally, you can support other [GitHub Actions](https://actions.cssnr.com/) - [Mirror Repository Action](https://github.com/cssnr/mirror-repository-action?tab=readme-ov-file#readme) - [Update Version Tags Action](https://github.com/cssnr/update-version-tags-action?tab=readme-ov-file#readme) - [Docker Tags Action](https://github.com/cssnr/docker-tags-action?tab=readme-ov-file#readme) +- [TOML Action](https://github.com/cssnr/toml-action?tab=readme-ov-file#readme) - [Update JSON Value Action](https://github.com/cssnr/update-json-value-action?tab=readme-ov-file#readme) - [JSON Key Value Check Action](https://github.com/cssnr/json-key-value-check-action?tab=readme-ov-file#readme) - [Parse Issue Form Action](https://github.com/cssnr/parse-issue-form-action?tab=readme-ov-file#readme) diff --git a/docs/actions.md b/docs/actions.md index 6698dae..206be1d 100644 --- a/docs/actions.md +++ b/docs/actions.md @@ -4,7 +4,7 @@ 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){target=\_blank} +[![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). diff --git a/docs/index.md b/docs/index.md index b7e6efb..41daed9 100644 --- a/docs/index.md +++ b/docs/index.md @@ -4,7 +4,7 @@ icon: lucide/rocket # :lucide-rocket: Get Started -[![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){target=\_blank} +[![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/) [![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) diff --git a/docs/javascripts/external-links.js b/docs/javascripts/external-links.js new file mode 100644 index 0000000..1bf83a7 --- /dev/null +++ b/docs/javascripts/external-links.js @@ -0,0 +1,12 @@ +// Open External Links in New Tab + +// noinspection JSUnresolvedReference,JSIgnoredPromiseFromCall +document$.subscribe(function () { + // console.log('processing:', window.location) + for (const el of document.querySelectorAll('a')) { + if (el.host !== globalThis.location.host) { + el.target = '_blank' + el.rel = 'noopener' + } + } +}) diff --git a/docs/support.md b/docs/support.md index 81a9161..feacef0 100644 --- a/docs/support.md +++ b/docs/support.md @@ -4,7 +4,7 @@ icon: lucide/message-circle-question-mark # :lucide-message-circle-question-mark: Support -[![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){target=\_blank} +[![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) @@ -25,7 +25,7 @@ or [Q&A](https://github.com/cssnr/actions-tools/discussions/categories/q-a). If you want to see a new feature, start a discussion in the [Feature Requests](https://github.com/cssnr/actions-tools/discussions/categories/feature-requests) section. -[:fontawesome-brands-github: Start A Discussion](https://github.com/cssnr/actions-tools/discussions){ .md-button .md-button--primary target=\_blank } +[:fontawesome-brands-github: Start A Discussion](https://github.com/cssnr/actions-tools/discussions){ .md-button .md-button--primary } ### GitHub Issues @@ -33,7 +33,7 @@ If you run into any problems or find a bug, please [open an issue](https://githu **These reports are treated with the highest priority.** -[:lucide-circle-alert: Report an Issue](https://github.com/cssnr/actions-tools/issues){ .md-button .md-button--primary target=\_blank } +[:lucide-circle-alert: Report an Issue](https://github.com/cssnr/actions-tools/issues){ .md-button .md-button--primary } ### Discord Chat @@ -41,7 +41,7 @@ You can chat with us about anything [on discord](https://discord.gg/wXy6m2X8wY). From here you can contact me directly, `Shane@111150265075298304`. -[:fontawesome-brands-discord: Chat on Discord](https://discord.gg/wXy6m2X8wY){ .md-button .md-button--primary target=\_blank } +[:fontawesome-brands-discord: Chat on Discord](https://discord.gg/wXy6m2X8wY){ .md-button .md-button--primary } ### General Feedback @@ -49,7 +49,7 @@ You can submit general feedback via the [web form](https://cssnr.github.io/feedb _This method is not recommended to [report issues](https://github.com/cssnr/actions-tools/issues) or [request features](https://github.com/cssnr/actions-tools/discussions/categories/feature-requests)._ -[:lucide-send: Send Feedback](https://cssnr.github.io/feedback/?app=actions-tools){ .md-button .md-button--primary target=\_blank } +[:lucide-send: Send Feedback](https://cssnr.github.io/feedback/?app=actions-tools){ .md-button .md-button--primary } ## Additional Links @@ -79,4 +79,4 @@ on [GitHub](https://github.com/cssnr/actions-tools?tab=readme-ov-file#contributi   -[![Support on Ko-fi](https://cdn.prod.website-files.com/5c14e387dab576fe667689cf/670f5a01c01ea9191809398c_support_me_on_kofi_blue.png){ width=360 }](https://ko-fi.com/cssnr){target=\_blank} +[![Support on Ko-fi](https://cdn.prod.website-files.com/5c14e387dab576fe667689cf/670f5a01c01ea9191809398c_support_me_on_kofi_blue.png){ width=360 }](https://ko-fi.com/cssnr) diff --git a/docs/usage.md b/docs/usage.md index 6b06e79..d9e813f 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -4,7 +4,7 @@ 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){target=\_blank} +[![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#install) import the module and start using the methods... @@ -166,7 +166,7 @@ core.summary.add_table([["Head 1", "Head 2"], ["data 1", "data 2"]]) # data 1data 2\n\n ``` -1. This can be any [GitHub flavored Markdown](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax){target=\_blank}. +1. This can be any [GitHub flavored Markdown](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax). Summary context handlers. diff --git a/pyproject.toml b/pyproject.toml index c602dd4..32e3e4c 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -51,7 +51,12 @@ Homepage = "https://cssnr.com/" Documentation = "https://actions-tools.cssnr.com/" Source = "https://github.com/cssnr/actions-tools" Issues = "https://github.com/cssnr/actions-tools/issues" +Changelog = "https://github.com/cssnr/actions-tools/releases" Funding = "https://ko-fi.com/cssnr" +Discord = "https://discord.gg/wXy6m2X8wY" + +Test = "https://github.com/cssnr/actions-tools/actions/workflows/test.yaml" +Coverage = "https://codecov.io/gh/cssnr/actions-tools" # Setup Tools [tool.setuptools.package-data] diff --git a/zensical.toml b/zensical.toml index fffdf23..f61eaa8 100644 --- a/zensical.toml +++ b/zensical.toml @@ -12,9 +12,9 @@ site_url = "https://actions-tools.cssnr.com/" # https://zensical.org/docs/setup/basics/#copyright copyright = """ -Actions Tools +Actions Tools
-Built with Zensical +Built with Zensical """ # https://zensical.org/docs/setup/navigation/ @@ -25,23 +25,11 @@ nav = [ {"Actions" = "actions.md"}, ] -# With the "extra_css" option you can add your own CSS styling to customize -# your Zensical project according to your needs. You can add any number of -# CSS files. -# -# The path provided should be relative to the "docs_dir". -# # https://zensical.org/docs/customization/#additional-css -# #extra_css = ["assets/stylesheets/extra.css"] -# With the `extra_javascript` option you can add your own JavaScript to your -# project to customize the behavior according to your needs. -# -# The path provided should be relative to the "docs_dir". -# # https://zensical.org/docs/customization/#additional-javascript -#extra_javascript = ["assets/javascript/extra.js"] +extra_javascript = ["javascripts/external-links.js"] # ---------------------------------------------------------------------------- # Section for configuring theme options @@ -61,8 +49,6 @@ logo = "https://raw.githubusercontent.com/smashedr/repo-images/refs/heads/master # https://zensical.org/docs/setup/language/ language = "en" -# Zensical provides a number of feature toggles that change the behavior -# of the documentation site. features = [ # https://zensical.org/docs/setup/header/#announcement-bar "announce.dismiss", @@ -235,6 +221,3 @@ name = "Website" [project.extra] generator = false - -#[project.markdown_extensions.toc] -#permalink = true