Skip to content

docs: add tested-platforms matrix; rename workflow to ci.yml #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
alexzhangs merged 2 commits into from
Jun 14, 2026
Merged

docs: add tested-platforms matrix; rename workflow to ci.yml #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7f4a682
docs: add tested-platforms matrix; rename workflow to ci.yml
alexzhangs Jun 14, 2026
2f24226
docs: add CodeFactor code-quality badge
alexzhangs Jun 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/ci-unittest.yml → .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: ci-unittest
name: CI

on:
push:
Expand Down
23 changes: 14 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
[![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)
[![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)

Expand All @@ -18,13 +19,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.

Expand Down Expand Up @@ -182,6 +188,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).