From 7f4a6829b9a4f1eb67bb06975a4903900fb1d8f9 Mon Sep 17 00:00:00 2001 From: Alex Date: Sun, 14 Jun 2026 21:52:43 +0800 Subject: [PATCH 1/2] docs: add tested-platforms matrix; rename workflow to ci.yml Replace the bash-version prose with an OS/shell test matrix. Rename ci-unittest.yml to ci.yml (name: CI) to match the other xsh repos; update badge and in-text references. Co-Authored-By: Claude Opus 4.8 (1M context) --- .github/workflows/{ci-unittest.yml => ci.yml} | 2 +- README.md | 22 +++++++++++-------- 2 files changed, 14 insertions(+), 10 deletions(-) rename .github/workflows/{ci-unittest.yml => ci.yml} (99%) diff --git a/.github/workflows/ci-unittest.yml b/.github/workflows/ci.yml similarity index 99% rename from .github/workflows/ci-unittest.yml rename to .github/workflows/ci.yml index df208de..704d3b5 100644 --- a/.github/workflows/ci-unittest.yml +++ b/.github/workflows/ci.yml @@ -1,4 +1,4 @@ -name: ci-unittest +name: CI on: push: diff --git a/README.md b/README.md index ae3bca2..4bcbff7 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![GitHub](https://img.shields.io/github/license/xsh-lib/git.svg?style=flat-square)](https://github.com/xsh-lib/git/) [![GitHub last commit](https://img.shields.io/github/last-commit/xsh-lib/git.svg?style=flat-square)](https://github.com/xsh-lib/git/commits/main) -[![ci-unittest](https://github.com/xsh-lib/git/actions/workflows/ci-unittest.yml/badge.svg)](https://github.com/xsh-lib/git/actions/workflows/ci-unittest.yml) +[![CI](https://github.com/xsh-lib/git/actions/workflows/ci.yml/badge.svg)](https://github.com/xsh-lib/git/actions/workflows/ci.yml) [![GitHub issues](https://img.shields.io/github/issues/xsh-lib/git.svg?style=flat-square)](https://github.com/xsh-lib/git/issues) [![GitHub pull requests](https://img.shields.io/github/issues-pr/xsh-lib/git.svg?style=flat-square)](https://github.com/xsh-lib/git/pulls) @@ -18,13 +18,18 @@ About xsh and its libraries, check out the [xsh document](https://github.com/ale ## Requirements -Tested with bash: +`xsh-lib/git` is tested in CI ([GitHub Actions](https://github.com/xsh-lib/git/actions/workflows/ci.yml)) on every push and pull request, across the following shell/OS combinations: -* 5.x and 4.x on Linux (ubuntu-latest in CI) -* 3.2.57 on macOS (macos-latest in CI) +| Shell | Version | OS | Tested | +|-------|---------|-----------------------|:------:| +| bash | 3.2 | macOS | ✅ | +| bash | 4.4 | Linux (rockylinux:8) | ✅ | +| bash | 5.x | Linux (ubuntu-latest) | ✅ | +| bash | 5.x | macOS (Homebrew) | ✅ | +| zsh | 5.x | Linux (ubuntu-latest) | ✅ | +| zsh | 5.x | macOS | ✅ | -The utilities also run under **zsh** (the default shell on modern macOS); xsh -executes them under zsh's ksh emulation. Tested with zsh 5.x. +zsh utilities run under xsh's ksh emulation and require **xsh ≥ 0.7.0**. This project is still at version `0.x` and should be considered immature. @@ -182,6 +187,5 @@ Network-dependent tests (real `gh` round-trips) are skipped by default. Enable them with `XSH_GIT_TEST_NETWORK=1` once you have a logged-in `gh` account available. -CI runs the same `test.sh` on `ubuntu-latest` and `macos-latest` for every -push and PR. See the -[ci-unittest workflow](.github/workflows/ci-unittest.yml). +CI runs the same `test.sh` across the shell/OS matrix above for every push and +PR. See the [CI workflow](.github/workflows/ci.yml). From 2f24226174c1b4238aedb4b04ad0d3d06bd8d1ef Mon Sep 17 00:00:00 2001 From: Alex Date: Sun, 14 Jun 2026 22:10:37 +0800 Subject: [PATCH 2/2] docs: add CodeFactor code-quality badge Co-Authored-By: Claude Opus 4.8 (1M context) --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 4bcbff7..3b59934 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,7 @@ [![GitHub last commit](https://img.shields.io/github/last-commit/xsh-lib/git.svg?style=flat-square)](https://github.com/xsh-lib/git/commits/main) [![CI](https://github.com/xsh-lib/git/actions/workflows/ci.yml/badge.svg)](https://github.com/xsh-lib/git/actions/workflows/ci.yml) +[![CodeFactor](https://www.codefactor.io/repository/github/xsh-lib/git/badge)](https://www.codefactor.io/repository/github/xsh-lib/git) [![GitHub issues](https://img.shields.io/github/issues/xsh-lib/git.svg?style=flat-square)](https://github.com/xsh-lib/git/issues) [![GitHub pull requests](https://img.shields.io/github/issues-pr/xsh-lib/git.svg?style=flat-square)](https://github.com/xsh-lib/git/pulls)