Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@ name: CI
on:
push:
branches:
- master
- main
pull_request:
branches:
- master
- main

jobs:
build:
Expand All @@ -23,7 +23,7 @@ jobs:
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: 20
node-version: 22
cache: pnpm

- name: Install dependencies
Expand Down
73 changes: 73 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
name: Release

on:
push:
branches: [main]

concurrency:
group: release-main
cancel-in-progress: false

permissions:
contents: write
id-token: write

jobs:
release:
runs-on: ubuntu-latest

steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0

- name: Setup Node
uses: actions/setup-node@v4
with:
node-version: 24
registry-url: https://registry.npmjs.org

- name: Enable Corepack
run: corepack enable

- name: Activate pnpm
run: corepack prepare pnpm@10.22.0 --activate

- name: Get pnpm store path
id: pnpm-store
run: echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_OUTPUT

- name: Cache pnpm store
uses: actions/cache@v4
with:
path: ${{ steps.pnpm-store.outputs.STORE_PATH }}
key: ${{ runner.os }}-pnpm-store-${{ hashFiles('pnpm-lock.yaml') }}
restore-keys: |
${{ runner.os }}-pnpm-store-

- name: Install dependencies
run: pnpm install --frozen-lockfile

- name: Typecheck
run: pnpm run typecheck

- name: Test
run: pnpm run test

- name: Build
run: pnpm run build

- name: Configure release git author
run: |
git config user.name "github-actions[bot]"
git config user.email "41898282+github-actions[bot]@users.noreply.github.com"

- name: Release
uses: teles/zero-release@v1.1.0
id: release
env:
ZERO_RELEASE_NPM_ACCESS: public
with:
branches: main
plugins: release-notes,changelog,package-json,git-commit,npm
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
## Table of contents

- [What's new in v1](#whats-new-in-v1)
- [Documentation](#documentation)
- [Installation](#installation)
- [Playground](#playground)
- [Quick start](#quick-start)
Expand Down Expand Up @@ -48,6 +49,10 @@ Why the change:
- **Generic types** — the result type is inferred from the inputs.
- **Options object** — opt into `limit`, `shuffle`, and `fill` strategies.

## Documentation

Open the official docs page at [ArrayMixer Docs](./docs/) for package manager commands, ESM, CommonJS, browser UMD, and TypeScript notes.

## Installation

```bash
Expand All @@ -69,7 +74,7 @@ CommonJS, ESM, and a UMD bundle are all shipped. For a `<script>` tag:

## Playground

Try the tuple API with emoji cards in the [ArrayMixer Playground](./playground.html).
Try the tuple API in the [ArrayMixer Playground](./playground/).

## Quick start

Expand Down
338 changes: 338 additions & 0 deletions docs/index.html

Large diffs are not rendered by default.

5 changes: 4 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,11 @@
},
"files": [
"release",
"playground.html",
"docs",
"playground",
"site-assets",
".readme/images/logo.png",
"CHANGELOG.md",
"README.md",
"LICENSE"
],
Expand Down
Loading
Loading