gh-setup-git-identity 0.2.0

package/.changeset/README.md

@@ -0,0 +1,8 @@
+# Changesets
+
+Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
+with multi-package repos, or single-package repos to help you version and publish your code. You can
+find the full documentation for it [in our repository](https://github.com/changesets/changesets)
+
+We have a quick list of common questions to get you started engaging with this project in
+[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

package/.changeset/config.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://unpkg.com/@changesets/config@3.1.1/schema.json",
+  "changelog": "@changesets/cli/changelog",
+  "commit": false,
+  "fixed": [],
+  "linked": [],
+  "access": "public",
+  "baseBranch": "main",
+  "updateInternalDependencies": "patch",
+  "ignore": []
+}

package/.github/workflows/release.yml

@@ -0,0 +1,306 @@
+name: Checks and release
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    types: [opened, synchronize, reopened]
+  # Manual release support - consolidated here to work with npm trusted publishing
+  # npm only allows ONE workflow file as trusted publisher, so all publishing
+  # must go through this workflow (release.yml)
+  workflow_dispatch:
+    inputs:
+      release_mode:
+        description: 'Manual release mode'
+        required: true
+        type: choice
+        default: 'instant'
+        options:
+          - instant
+          - changeset-pr
+      bump_type:
+        description: 'Manual release type'
+        required: true
+        type: choice
+        options:
+          - patch
+          - minor
+          - major
+      description:
+        description: 'Manual release description (optional)'
+        required: false
+        type: string
+
+concurrency: ${{ github.workflow }}-${{ github.ref }}
+
+jobs:
+  # Changeset check - only runs on PRs
+  changeset-check:
+    name: Check for Changesets
+    runs-on: ubuntu-latest
+    if: github.event_name == 'pull_request'
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Check for changesets
+        run: |
+          # Skip changeset check for automated version PRs
+          if [[ "${{ github.head_ref }}" == "changeset-release/"* ]]; then
+            echo "Skipping changeset check for automated release PR"
+            exit 0
+          fi
+
+          # Run changeset validation script
+          node scripts/validate-changeset.mjs
+
+  # Linting - runs after changeset check on PRs, immediately on main
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    needs: [changeset-check]
+    if: always() && (github.event_name == 'push' || needs.changeset-check.result == 'success')
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Run lint
+        run: npm run lint
+
+  # Test matrix: 3 runtimes (Node.js, Bun, Deno) x 3 OS (Ubuntu, macOS, Windows)
+  # Note: Bun on Windows excluded due to known timeout issues with process spawning
+  test:
+    name: Test (${{ matrix.runtime }} on ${{ matrix.os }})
+    runs-on: ${{ matrix.os }}
+    needs: [changeset-check]
+    if: always() && (github.event_name == 'push' || needs.changeset-check.result == 'success')
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        runtime: [node, bun, deno]
+        exclude:
+          # Exclude Bun on Windows due to known timeout issues with process spawning
+          - os: windows-latest
+            runtime: bun
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        if: matrix.runtime == 'node'
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+
+      - name: Install dependencies (Node.js)
+        if: matrix.runtime == 'node'
+        run: npm install
+
+      - name: Run tests (Node.js)
+        if: matrix.runtime == 'node'
+        run: npm test
+
+      - name: Setup Bun
+        if: matrix.runtime == 'bun'
+        uses: oven-sh/setup-bun@v2
+        with:
+          bun-version: latest
+
+      - name: Install dependencies (Bun)
+        if: matrix.runtime == 'bun'
+        run: bun install
+
+      - name: Run tests (Bun)
+        if: matrix.runtime == 'bun'
+        run: bun test
+
+      - name: Setup Deno
+        if: matrix.runtime == 'deno'
+        uses: denoland/setup-deno@v2
+        with:
+          deno-version: v2.x
+
+      - name: Install dependencies (Deno)
+        if: matrix.runtime == 'deno'
+        run: deno install
+
+      - name: Run tests (Deno)
+        if: matrix.runtime == 'deno'
+        run: deno test --allow-all
+
+  # Release - only runs on main after tests pass (for push events)
+  release:
+    name: Release
+    needs: [lint, test]
+    # Use always() to ensure this job runs even if changeset-check was skipped
+    # This is needed because lint/test jobs have a transitive dependency on changeset-check
+    if: always() && github.ref == 'refs/heads/main' && github.event_name == 'push' && needs.lint.result == 'success' && needs.test.result == 'success'
+    runs-on: ubuntu-latest
+    # Permissions required for npm OIDC trusted publishing
+    permissions:
+      contents: write
+      pull-requests: write
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Update npm for OIDC trusted publishing
+        run: node scripts/setup-npm.mjs
+
+      - name: Check for changesets
+        id: check_changesets
+        run: |
+          # Count changeset files (excluding README.md and config.json)
+          CHANGESET_COUNT=$(find .changeset -name "*.md" ! -name "README.md" | wc -l)
+          echo "Found $CHANGESET_COUNT changeset file(s)"
+          echo "has_changesets=$([[ $CHANGESET_COUNT -gt 0 ]] && echo 'true' || echo 'false')" >> $GITHUB_OUTPUT
+
+      - name: Version packages and commit to main
+        if: steps.check_changesets.outputs.has_changesets == 'true'
+        id: version
+        run: node scripts/version-and-commit.mjs --mode changeset
+
+      - name: Publish to npm
+        # Run if version was committed OR if a previous attempt already committed (for re-runs)
+        if: steps.version.outputs.version_committed == 'true' || steps.version.outputs.already_released == 'true'
+        id: publish
+        run: node scripts/publish-to-npm.mjs --should-pull
+
+      - name: Create GitHub Release
+        if: steps.publish.outputs.published == 'true'
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: node scripts/create-github-release.mjs --release-version "${{ steps.publish.outputs.published_version }}" --repository "${{ github.repository }}"
+
+      - name: Format GitHub release notes
+        if: steps.publish.outputs.published == 'true'
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: node scripts/format-github-release.mjs --release-version "${{ steps.publish.outputs.published_version }}" --repository "${{ github.repository }}" --commit-sha "${{ github.sha }}"
+
+  # Manual Instant Release - triggered via workflow_dispatch with instant mode
+  # This job is in release.yml because npm trusted publishing
+  # only allows one workflow file to be registered as a trusted publisher
+  instant-release:
+    name: Instant Release
+    if: github.event_name == 'workflow_dispatch' && github.event.inputs.release_mode == 'instant'
+    runs-on: ubuntu-latest
+    # Permissions required for npm OIDC trusted publishing
+    permissions:
+      contents: write
+      pull-requests: write
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Update npm for OIDC trusted publishing
+        run: node scripts/setup-npm.mjs
+
+      - name: Version packages and commit to main
+        id: version
+        run: node scripts/version-and-commit.mjs --mode instant --bump-type "${{ github.event.inputs.bump_type }}" --description "${{ github.event.inputs.description }}"
+
+      - name: Publish to npm
+        # Run if version was committed OR if a previous attempt already committed (for re-runs)
+        if: steps.version.outputs.version_committed == 'true' || steps.version.outputs.already_released == 'true'
+        id: publish
+        run: node scripts/publish-to-npm.mjs
+
+      - name: Create GitHub Release
+        if: steps.publish.outputs.published == 'true'
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: node scripts/create-github-release.mjs --release-version "${{ steps.publish.outputs.published_version }}" --repository "${{ github.repository }}"
+
+      - name: Format GitHub release notes
+        if: steps.publish.outputs.published == 'true'
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: node scripts/format-github-release.mjs --release-version "${{ steps.publish.outputs.published_version }}" --repository "${{ github.repository }}" --commit-sha "${{ github.sha }}"
+
+  # Manual Changeset PR - creates a pull request with the changeset for review
+  changeset-pr:
+    name: Create Changeset PR
+    if: github.event_name == 'workflow_dispatch' && github.event.inputs.release_mode == 'changeset-pr'
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Create changeset file
+        run: node scripts/create-manual-changeset.mjs --bump-type "${{ github.event.inputs.bump_type }}" --description "${{ github.event.inputs.description }}"
+
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v7
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          commit-message: 'chore: add changeset for manual ${{ github.event.inputs.bump_type }} release'
+          branch: changeset-manual-release-${{ github.run_id }}
+          delete-branch: true
+          title: 'chore: manual ${{ github.event.inputs.bump_type }} release'
+          body: |
+            ## Manual Release Request
+
+            This PR was created by a manual workflow trigger to prepare a **${{ github.event.inputs.bump_type }}** release.
+
+            ### Release Details
+            - **Type:** ${{ github.event.inputs.bump_type }}
+            - **Description:** ${{ github.event.inputs.description || 'Manual release' }}
+            - **Triggered by:** @${{ github.actor }}
+
+            ### Next Steps
+            1. Review the changeset in this PR
+            2. Merge this PR to main
+            3. The automated release workflow will create a version PR
+            4. Merge the version PR to publish to npm and create a GitHub release

package/CHANGELOG.md

@@ -0,0 +1,16 @@
+# gh-setup-git-identity
+
+## 0.2.0
+
+### Minor Changes
+
+- b8ecb63: Update CI/CD pipeline and testing framework to match test-anywhere patterns
+
+  - Consolidate GitHub Actions workflow into single release.yml file
+  - Add unified test matrix for Node.js, Bun, and Deno across Ubuntu, macOS, and Windows
+  - Add Node.js scripts for release automation (validate-changeset, version-and-commit, publish-to-npm, etc.)
+  - Add support for manual releases via workflow_dispatch (instant and changeset-pr modes)
+  - Add npm OIDC trusted publishing support
+  - Add GitHub release formatting with shields.io badges and PR links
+  - Update changeset configuration to use @changesets/cli/changelog
+  - Add changeset:status script for checking changeset status

package/LICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <https://unlicense.org>

package/README.md

@@ -0,0 +1,246 @@
+# gh-setup-git-identity
+
+A tool to setup git identity based on current GitHub user.
+
+[![License: Unlicense](https://img.shields.io/badge/license-Unlicense-blue.svg)](http://unlicense.org/)
+[![Node.js Version](https://img.shields.io/badge/node-%3E%3D20.0.0-brightgreen.svg)](https://nodejs.org/)
+
+## Overview
+
+`gh-setup-git-identity` is a CLI tool that simplifies setting up your git identity using your GitHub account. It automatically fetches your GitHub username and primary email address, then configures git with these values.
+
+Instead of manually running:
+
+```bash
+gh auth login -h github.com -s repo,workflow,user,read:org,gist
+
+USERNAME=$(gh api user --jq '.login')
+EMAIL=$(gh api user/emails --jq '.[] | select(.primary==true) | .email')
+
+git config --global user.name "$USERNAME"
+git config --global user.email "$EMAIL"
+```
+
+You can simply run:
+
+```bash
+gh-setup-git-identity
+```
+
+## Features
+
+- **Automatic identity setup**: Fetches username and email from GitHub
+- **Global and local configuration**: Configure git globally or per-repository
+- **Authentication check**: Prompts you to login if not authenticated
+- **Dry-run mode**: Preview changes without making them
+- **Cross-platform**: Works on macOS, Linux, and Windows
+- **Verbose mode**: Built-in verbose mode for debugging
+
+## Prerequisites
+
+- Node.js >= 20.0.0
+- Git (installed and configured)
+- GitHub CLI (`gh`) installed
+
+To install GitHub CLI, see: https://cli.github.com/
+
+## Installation
+
+### Global Installation (CLI)
+
+```bash
+npm install -g gh-setup-git-identity
+```
+
+### Local Installation (Library)
+
+```bash
+npm install gh-setup-git-identity
+```
+
+## CLI Usage
+
+### Basic Usage
+
+```bash
+# Setup git identity globally (default)
+gh-setup-git-identity
+
+# Setup git identity for current repository only
+gh-setup-git-identity --local
+
+# Preview what would be configured (dry run)
+gh-setup-git-identity --dry-run
+
+# Enable verbose output
+gh-setup-git-identity --verbose
+```
+
+### CLI Options
+
+```
+Usage: gh-setup-git-identity [options]
+
+Options:
+  --global, -g     Set git config globally (default: true)
+  --local, -l      Set git config locally (in current repository)
+  --dry-run, --dry Dry run - show what would be done without making changes
+  --verbose, -v    Enable verbose output
+  --help, -h       Show help
+  --version        Show version number
+```
+
+### First Run (Not Authenticated)
+
+If you haven't authenticated with GitHub CLI yet, the tool will prompt you:
+
+```
+GitHub CLI is not authenticated.
+
+Please run the following command to login:
+
+  gh auth login -h github.com -s repo,workflow,user,read:org,gist
+
+After logging in, run gh-setup-git-identity again.
+```
+
+### Successful Run
+
+```
+Fetching GitHub user information...
+GitHub user: your-username
+GitHub email: your-email@example.com
+
+Configuring git (global)...
+Git identity configured successfully!
+
+Git configured:
+
+  user.name:  your-username
+  user.email: your-email@example.com
+
+Scope: global (--global)
+
+Git identity setup complete!
+```
+
+## Library Usage
+
+### Basic Example
+
+```javascript
+import { setupGitIdentity, isGhAuthenticated } from 'gh-setup-git-identity';
+
+// Check if authenticated first
+const authenticated = await isGhAuthenticated();
+if (!authenticated) {
+  console.log('Please run: gh auth login');
+  process.exit(1);
+}
+
+// Setup git identity
+const result = await setupGitIdentity();
+console.log('Configured:', result.username, result.email);
+
+// Setup with options
+const result2 = await setupGitIdentity({
+  scope: 'local',      // 'global' or 'local'
+  dryRun: true,        // Preview only
+  verbose: true        // Enable verbose logging
+});
+```
+
+### API Reference
+
+#### `isGhAuthenticated(options?)`
+
+Check if GitHub CLI is authenticated.
+
+**Returns:** `Promise<boolean>`
+
+#### `getGitHubUserInfo(options?)`
+
+Get GitHub user information (username and primary email).
+
+**Returns:** `Promise<{username: string, email: string}>`
+
+#### `setupGitIdentity(options?)`
+
+Setup git identity based on GitHub user.
+
+**Parameters:**
+- `options.scope` - `'global'` or `'local'` (default: `'global'`)
+- `options.dryRun` - Preview only, don't make changes (default: `false`)
+- `options.verbose` - Enable verbose logging (default: `false`)
+- `options.logger` - Custom logger (default: `console`)
+
+**Returns:** `Promise<{username: string, email: string}>`
+
+#### `verifyGitIdentity(options?)`
+
+Get current git identity configuration.
+
+**Returns:** `Promise<{username: string|null, email: string|null}>`
+
+## Configuration
+
+### Environment Variables
+
+- `GH_SETUP_GIT_IDENTITY_GLOBAL` - Set global config (default: `true`)
+- `GH_SETUP_GIT_IDENTITY_LOCAL` - Set local config (default: `false`)
+- `GH_SETUP_GIT_IDENTITY_DRY_RUN` - Enable dry run mode (default: `false`)
+- `GH_SETUP_GIT_IDENTITY_VERBOSE` - Enable verbose output (default: `false`)
+
+## Testing
+
+Run tests using your preferred runtime:
+
+```bash
+# Node.js
+npm test
+
+# Bun
+bun test
+
+# Deno
+deno test --allow-all
+```
+
+## Development
+
+### Project Structure
+
+```
+gh-setup-git-identity/
+├── src/
+│   ├── index.js          # Core library
+│   └── cli.js            # CLI interface
+├── test/
+│   └── index.test.js     # Tests
+├── .changeset/           # Changesets for versioning
+├── .github/
+│   └── workflows/        # CI/CD workflows
+├── package.json
+└── README.md
+```
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+This is free and unencumbered software released into the public domain. See [LICENSE](LICENSE) for details.
+
+## Links
+
+- GitHub Repository: https://github.com/link-foundation/gh-setup-git-identity
+- Issue Tracker: https://github.com/link-foundation/gh-setup-git-identity/issues
+- Link Foundation: https://github.com/link-foundation
+
+## Related Projects
+
+- [gh-upload-log](https://github.com/link-foundation/gh-upload-log) - Upload log files to GitHub
+- [lino-arguments](https://github.com/link-foundation/lino-arguments) - CLI argument parsing
+- [log-lazy](https://github.com/link-foundation/log-lazy) - Efficient lazy evaluation logging
+- [command-stream](https://github.com/link-foundation/command-stream) - Streamable commands

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "gh-setup-git-identity",
+  "version": "0.2.0",
+  "description": "A tool to setup git identity based on current gh user",
+  "type": "module",
+  "main": "src/index.js",
+  "bin": {
+    "gh-setup-git-identity": "src/cli.js"
+  },
+  "scripts": {
+    "test": "node --test test/index.test.js",
+    "test:bun": "bun test",
+    "test:deno": "deno test --allow-all",
+    "lint": "node --check src/index.js && node --check src/cli.js",
+    "changeset": "changeset",
+    "changeset:version": "node scripts/changeset-version.mjs",
+    "changeset:publish": "changeset publish",
+    "changeset:status": "changeset status --since=origin/main"
+  },
+  "keywords": [
+    "github",
+    "git",
+    "identity",
+    "config",
+    "cli",
+    "setup"
+  ],
+  "author": "Link Foundation",
+  "license": "Unlicense",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/link-foundation/gh-setup-git-identity.git"
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "dependencies": {
+    "lino-arguments": "^0.2.1",
+    "log-lazy": "^1.0.4",
+    "yargs": "^17.7.2"
+  },
+  "devDependencies": {
+    "@changesets/cli": "^2.29.7",
+    "test-anywhere": "^0.7.0"
+  }
+}

package/scripts/changeset-version.mjs

@@ -0,0 +1,38 @@
+#!/usr/bin/env node
+
+/**
+ * Custom changeset version script that ensures package-lock.json is synchronized
+ * with package.json after version bumps.
+ *
+ * This script:
+ * 1. Runs `changeset version` to update package versions
+ * 2. Runs `npm install` to synchronize package-lock.json with the new versions
+ *
+ * Uses link-foundation libraries:
+ * - use-m: Dynamic package loading without package.json dependencies
+ * - command-stream: Modern shell command execution with streaming support
+ */
+
+// Load use-m dynamically
+const { use } = eval(
+  await (await fetch('https://unpkg.com/use-m/use.js')).text()
+);
+
+// Import command-stream for shell command execution
+const { $ } = await use('command-stream');
+
+try {
+  console.log('Running changeset version...');
+  await $`npx changeset version`;
+
+  console.log('\nSynchronizing package-lock.json...');
+  await $`npm install --package-lock-only`;
+
+  console.log('\nVersion bump complete with synchronized package-lock.json');
+} catch (error) {
+  console.error('Error during version bump:', error.message);
+  if (process.env.DEBUG) {
+    console.error('Stack trace:', error.stack);
+  }
+  process.exit(1);
+}