From b15b9bed810f76ad5c34837abe3236343b69db00 Mon Sep 17 00:00:00 2001 From: Salvydas Lukosius Date: Fri, 15 May 2026 18:45:35 +0100 Subject: [PATCH] docs(readme): update formatting for clarity and consistency build(workflows): adjust paths in deployment workflow chore(trunk): update runtime versions and linting configuration style(svg): optimize SVG files for better performance Signed-off-by: Salvydas Lukosius --- .github/README.md | 100 ++++++++++++------------- .github/workflows/gh-deploy-assets.yml | 2 +- .trunk/trunk.yaml | 14 ++-- profile/img/card-community.svg | 29 +------ profile/img/card-ecosystem.svg | 29 +------ profile/img/card-plugin-mgr.svg | 28 +------ profile/img/card-turbo.svg | 26 +------ 7 files changed, 62 insertions(+), 166 deletions(-) diff --git a/.github/README.md b/.github/README.md index cfbdf8b82..eaa4c12d4 100644 --- a/.github/README.md +++ b/.github/README.md @@ -21,14 +21,14 @@ The `.github` repository is a [special GitHub repository](https://docs.github.co ### What Makes It Special -| Feature | How It Works | -| --- | --- | -| **Organization Profile** | `profile/README.md` is rendered on the [organization's GitHub page](https://github.com/z-shell) as the public-facing profile. | -| **Default Community Health Files** | Files like `CODE_OF_CONDUCT.md`, `CONTRIBUTING.md`, `SECURITY.md`, and `GOVERNANCE.md` in `.github/` are used as fallbacks by any org repository that doesn't define its own. | -| **Default Issue & PR Templates** | Templates in `.github/ISSUE_TEMPLATE/` and discussion forms in `.github/DISCUSSION_TEMPLATE/` are inherited by repositories without their own templates. | -| **Reusable Composite Actions** | The `actions/` directory hosts [composite actions](https://docs.github.com/en/actions/creating-actions/creating-a-composite-action) that any org repository can reference via `uses: z-shell/.github/actions/@main`. | -| **Workflow Templates** | The `workflow-templates/` directory provides [starter workflows](https://docs.github.com/en/actions/using-workflows/creating-starter-workflows-for-your-organization) available in every org repository under **Actions > New workflow**. | -| **Shared Dependency Config** | `renovate-config.json` defines a shared [Renovate](https://docs.renovatebot.com/) preset that org repositories can extend for consistent automated dependency updates. | +| Feature | How It Works | +| ---------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **Organization Profile** | `profile/README.md` is rendered on the [organization's GitHub page](https://github.com/z-shell) as the public-facing profile. | +| **Default Community Health Files** | Files like `CODE_OF_CONDUCT.md`, `CONTRIBUTING.md`, `SECURITY.md`, and `GOVERNANCE.md` in `.github/` are used as fallbacks by any org repository that doesn't define its own. | +| **Default Issue & PR Templates** | Templates in `.github/ISSUE_TEMPLATE/` and discussion forms in `.github/DISCUSSION_TEMPLATE/` are inherited by repositories without their own templates. | +| **Reusable Composite Actions** | The `actions/` directory hosts [composite actions](https://docs.github.com/en/actions/creating-actions/creating-a-composite-action) that any org repository can reference via `uses: z-shell/.github/actions/@main`. | +| **Workflow Templates** | The `workflow-templates/` directory provides [starter workflows](https://docs.github.com/en/actions/using-workflows/creating-starter-workflows-for-your-organization) available in every org repository under **Actions > New workflow**. | +| **Shared Dependency Config** | `renovate-config.json` defines a shared [Renovate](https://docs.renovatebot.com/) preset that org repositories can extend for consistent automated dependency updates. | > **Note:** The `.github` repository must be **public** for default community health files to apply across the organization. @@ -36,31 +36,31 @@ The `.github` repository is a [special GitHub repository](https://docs.github.co ## Repository Structure -| Path | Purpose | -| --- | --- | -| [`profile/`](../profile/) | Organization profile — the README and visual assets displayed on the [org page](https://github.com/z-shell) | -| [`actions/`](../actions/) | Reusable composite GitHub Actions shared across all org repositories | -| [`workflow-templates/`](../workflow-templates/) | Starter workflow templates available in the **Actions > New workflow** tab | -| [`metrics/`](../metrics/) | Auto-generated organization metrics and analytics | -| [`renovate-config.json`](../renovate-config.json) | Shared Renovate bot preset for dependency updates | +| Path | Purpose | +| ------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | +| [`profile/`](../profile/) | Organization profile — the README and visual assets displayed on the [org page](https://github.com/z-shell) | +| [`actions/`](../actions/) | Reusable composite GitHub Actions shared across all org repositories | +| [`workflow-templates/`](../workflow-templates/) | Starter workflow templates available in the **Actions > New workflow** tab | +| [`metrics/`](../metrics/) | Auto-generated organization metrics and analytics | +| [`renovate-config.json`](../renovate-config.json) | Shared Renovate bot preset for dependency updates | ### Community Health Files These files in `.github/` act as **organization-wide defaults** — automatically used by any repository that doesn't have its own version: -| File | Purpose | -| --- | --- | -| [`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md) | Contributor Covenant code of conduct | -| [`CONTRIBUTING.md`](CONTRIBUTING.md) | Contribution guidelines and requirements | -| [`SECURITY.md`](SECURITY.md) | Security vulnerability reporting policy | -| [`GOVERNANCE.md`](GOVERNANCE.md) | Project governance roles and decision-making | -| [`CHARTER.md`](CHARTER.md) | Organizational charter and mission | -| [`STEERING_COMMITTEE.md`](STEERING_COMMITTEE.md) | Steering committee membership | -| [`MAINTAINERS.md`](MAINTAINERS.md) | Project maintainer list | -| [`TRADEMARKS.md`](TRADEMARKS.md) | Trademark usage policy | -| [`ANTITRUST.md`](ANTITRUST.md) | Antitrust compliance policy | -| [`ISSUE_TEMPLATE/`](ISSUE_TEMPLATE/) | Default issue forms (bug reports, features, docs, membership) | -| [`DISCUSSION_TEMPLATE/`](DISCUSSION_TEMPLATE/) | Default discussion category forms | +| File | Purpose | +| ------------------------------------------------ | ------------------------------------------------------------- | +| [`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md) | Contributor Covenant code of conduct | +| [`CONTRIBUTING.md`](CONTRIBUTING.md) | Contribution guidelines and requirements | +| [`SECURITY.md`](SECURITY.md) | Security vulnerability reporting policy | +| [`GOVERNANCE.md`](GOVERNANCE.md) | Project governance roles and decision-making | +| [`CHARTER.md`](CHARTER.md) | Organizational charter and mission | +| [`STEERING_COMMITTEE.md`](STEERING_COMMITTEE.md) | Steering committee membership | +| [`MAINTAINERS.md`](MAINTAINERS.md) | Project maintainer list | +| [`TRADEMARKS.md`](TRADEMARKS.md) | Trademark usage policy | +| [`ANTITRUST.md`](ANTITRUST.md) | Antitrust compliance policy | +| [`ISSUE_TEMPLATE/`](ISSUE_TEMPLATE/) | Default issue forms (bug reports, features, docs, membership) | +| [`DISCUSSION_TEMPLATE/`](DISCUSSION_TEMPLATE/) | Default discussion category forms | --- @@ -68,19 +68,19 @@ These files in `.github/` act as **organization-wide defaults** — automaticall Composite actions available to all repositories via `z-shell/.github/actions/`: -| Action | Description | -| --- | --- | -| [`setup-zsh`](../actions/setup-zsh) | Set up Zsh environment for CI | +| Action | Description | +| ----------------------------------------------------------- | ---------------------------------- | +| [`setup-zsh`](../actions/setup-zsh) | Set up Zsh environment for CI | | [`setup-zsh-development`](../actions/setup-zsh-development) | Set up Zsh development environment | -| [`build-zpmod-module`](../actions/build-zpmod-module) | Build the Zpmod Zsh module | -| [`test-zpmod-module`](../actions/test-zpmod-module) | Test the Zpmod module | -| [`test-zsh-module`](../actions/test-zsh-module) | Test Zsh modules | -| [`commit`](../actions/commit) | Automated commit action | -| [`rebase`](../actions/rebase) | Automated rebase action | -| [`mirror`](../actions/mirror) | Repository mirroring | -| [`rclone`](../actions/rclone) | File sync with rclone | -| [`determine-branch`](../actions/determine-branch) | Determine target branch | -| [`verify-pr-labels`](../actions/verify-pr-labels) | Verify PR label compliance | +| [`build-zpmod-module`](../actions/build-zpmod-module) | Build the Zpmod Zsh module | +| [`test-zpmod-module`](../actions/test-zpmod-module) | Test the Zpmod module | +| [`test-zsh-module`](../actions/test-zsh-module) | Test Zsh modules | +| [`commit`](../actions/commit) | Automated commit action | +| [`rebase`](../actions/rebase) | Automated rebase action | +| [`mirror`](../actions/mirror) | Repository mirroring | +| [`rclone`](../actions/rclone) | File sync with rclone | +| [`determine-branch`](../actions/determine-branch) | Determine target branch | +| [`verify-pr-labels`](../actions/verify-pr-labels) | Verify PR label compliance | **Usage example:** @@ -93,16 +93,16 @@ steps: Starter workflows available in every org repository under **Actions > New workflow**: -| Template | Description | -| --- | --- | -| Commit Action | Automated commit workflow | -| Rebase Action | PR auto-rebase workflow | -| Lock Action | Issue/PR auto-lock | -| Stale Action | Stale issue management | -| Trunk | Trunk.io linting integration | -| Sync Labels | Label synchronization | -| Verify PR Labels | PR label validation | -| Rclone Action | File sync with rclone | +| Template | Description | +| ---------------- | ---------------------------- | +| Commit Action | Automated commit workflow | +| Rebase Action | PR auto-rebase workflow | +| Lock Action | Issue/PR auto-lock | +| Stale Action | Stale issue management | +| Trunk | Trunk.io linting integration | +| Sync Labels | Label synchronization | +| Verify PR Labels | PR label validation | +| Rclone Action | File sync with rclone | ## Renovate diff --git a/.github/workflows/gh-deploy-assets.yml b/.github/workflows/gh-deploy-assets.yml index 67024d36b..fc1aad816 100644 --- a/.github/workflows/gh-deploy-assets.yml +++ b/.github/workflows/gh-deploy-assets.yml @@ -4,7 +4,7 @@ name: "🚀 Deploy Assets" on: push: branches: [main] - paths: ["./profile/**", "!.metrics/"] + paths: ["profile/**", "!.metrics/"] workflow_dispatch: {} permissions: read-all diff --git a/.trunk/trunk.yaml b/.trunk/trunk.yaml index bedae39d7..6f02c5422 100644 --- a/.trunk/trunk.yaml +++ b/.trunk/trunk.yaml @@ -22,10 +22,10 @@ lint: - trufflehog - yamllint - vale + - ruff enabled: - oxipng@10.1.0 - bandit@1.9.4 - - ruff@0.15.11 - taplo@0.10.0 - isort@8.0.1 - flake8@7.3.0 @@ -43,14 +43,14 @@ lint: - linters: [svgo] paths: - "metrics/**" - - linters: [markdownlint] - paths: - - ".github/styles/**" +# - linters: [markdownlint] +# paths: +# - ".github/styles/**" runtimes: enabled: - - python@3.10.8 - - go@1.21.0 - - node@22.16.0 + - python@3.13.3 + - go@1.24.0 + - node@23.8.0 actions: disabled: - trunk-check-pre-push diff --git a/profile/img/card-community.svg b/profile/img/card-community.svg index 8ef3dd569..3663915b0 100644 --- a/profile/img/card-community.svg +++ b/profile/img/card-community.svg @@ -1,28 +1 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file + \ No newline at end of file diff --git a/profile/img/card-ecosystem.svg b/profile/img/card-ecosystem.svg index 40caa6e78..05b5747df 100644 --- a/profile/img/card-ecosystem.svg +++ b/profile/img/card-ecosystem.svg @@ -1,28 +1 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file + \ No newline at end of file diff --git a/profile/img/card-plugin-mgr.svg b/profile/img/card-plugin-mgr.svg index 5ff823e88..ec93c7fb0 100644 --- a/profile/img/card-plugin-mgr.svg +++ b/profile/img/card-plugin-mgr.svg @@ -1,27 +1 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file + \ No newline at end of file diff --git a/profile/img/card-turbo.svg b/profile/img/card-turbo.svg index d992bb047..a9010c907 100644 --- a/profile/img/card-turbo.svg +++ b/profile/img/card-turbo.svg @@ -1,25 +1 @@ - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file + \ No newline at end of file