@dougefresh/ci 0.1.11

package/.github/copilot-instructions.md

@@ -0,0 +1,118 @@
+# Copilot Instructions
+
+This GitHub Action is written in TypeScript and transpiled to JavaScript. Both the TypeScript sources and the
+**generated** JavaScript code are contained in this repository. The TypeScript sources are contained in the `src`
+directory and the JavaScript code is contained in the `dist` directory. A GitHub Actions workflow checks that the
+JavaScript code in `dist` is up-to-date. Therefore, you should not review any changes to the contents of the `dist`
+folder and it is expected that the JavaScript code in `dist` closely mirrors the TypeScript code it is generated from.
+
+## Repository Structure
+
+| Path                 | Description                                              |
+| -------------------- | -------------------------------------------------------- |
+| `__fixtures__/`      | Unit Test Fixtures                                       |
+| `__tests__/`         | Unit Tests                                               |
+| `.devcontainer/`     | Development Container Configuration                      |
+| `.github/`           | GitHub Configuration                                     |
+| `.licenses/`         | License Information                                      |
+| `.vscode/`           | Visual Studio Code Configuration                         |
+| `badges/`            | Badges for readme                                        |
+| `dist/`              | Generated JavaScript Code                                |
+| `src/`               | TypeScript Source Code                                   |
+| `.env.example`       | Environment Variables Example for `@github/local-action` |
+| `.licensed.yml`      | Licensed Configuration                                   |
+| `.markdown-lint.yml` | Markdown Linter Configuration                            |
+| `.node-version`      | Node.js Version Configuration                            |
+| `.prettierrc.yml`    | Prettier Formatter Configuration                         |
+| `.yaml-lint.yml`     | YAML Linter Configuration                                |
+| `action.yml`         | GitHub Action Metadata                                   |
+| `CODEOWNERS`         | Code Owners File                                         |
+| `eslint.config.mjs`  | ESLint Configuration                                     |
+| `jest.config.js`     | Jest Configuration                                       |
+| `LICENSE`            | License File                                             |
+| `package.json`       | NPM Package Configuration                                |
+| `README.md`          | Project Documentation                                    |
+| `rollup.config.ts`   | Rollup Bundler Configuration                             |
+| `tsconfig.json`      | TypeScript Configuration                                 |
+
+## Environment Setup
+
+Install dependencies by running:
+
+```bash
+npm install
+```
+
+## Testing
+
+Ensure all unit tests pass by running:
+
+```bash
+npm run test
+```
+
+Unit tests should exist in the `__tests__` directory. They are powered by `jest`. Fixtures should be placed in the
+`__fixtures__` directory.
+
+## Bundling
+
+Any time files in the `src` directory are changed, you should run the following command to bundle the TypeScript code
+into JavaScript:
+
+```bash
+npm run bundle
+```
+
+## General Coding Guidelines
+
+- Follow standard TypeScript and JavaScript coding conventions and best practices
+- Changes should maintain consistency with existing patterns and style
+- Document changes clearly and thoroughly, including updates to existing comments when appropriate
+- Do not include basic, unnecessary comments that simply restate what the code is doing (focus on explaining _why_, not
+  _what_)
+- Use consistent error handling patterns throughout the codebase
+- Use TypeScript's type system to ensure type safety and clarity
+- Keep functions focused and manageable
+- Use descriptive variable and function names that clearly convey their purpose
+- Use JSDoc comments to document functions, classes, and complex logic
+- After doing any refactoring, ensure to run `npm run test` to ensure that all tests still pass and coverage
+  requirements are met
+- When suggesting code changes, always opt for the most maintainable approach. Try your best to keep the code clean and
+  follow "Don't Repeat Yourself" (DRY) principles
+- Avoid unnecessary complexity and always consider the long-term maintainability of the code
+- When writing unit tests, try to consider edge cases as well as the main path of success. This will help ensure that
+  the code is robust and can handle unexpected inputs or situations
+- Use the `@actions/core` package for logging over `console` to ensure compatibility with GitHub Actions logging
+  features
+
+### Versioning
+
+GitHub Actions are versioned using branch and tag names. Please ensure the version in the project's `package.json` is
+updated to reflect the changes made in the codebase. The version should follow
+[Semantic Versioning](https://semver.org/) principles.
+
+## Pull Request Guidelines
+
+When creating a pull request (PR), please ensure that:
+
+- Keep changes focused and minimal (avoid large changes, or consider breaking them into separate, smaller PRs)
+- Formatting checks pass
+- Linting checks pass
+- Unit tests pass and coverage requirements are met
+- The action has been transpiled to JavaScript and the `dist` directory is up-to-date with the latest changes in the
+  `src` directory
+- If necessary, the `README.md` file is updated to reflect any changes in functionality or usage
+
+The body of the PR should include:
+
+- A summary of the changes
+- A special note of any changes to dependencies
+- A link to any relevant issues or discussions
+- Any additional context that may be helpful for reviewers
+
+## Code Review Guidelines
+
+When performing a code review, please follow these guidelines:
+
+- If there are changes that modify the functionality/usage of the action, validate that there are changes in the
+  `README.md` file that document the new or modified functionality

package/.github/dependabot.yml

@@ -0,0 +1,26 @@
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: weekly
+    groups:
+      actions-minor:
+        update-types:
+          - minor
+          - patch
+
+  - package-ecosystem: npm
+    directory: /
+    schedule:
+      interval: weekly
+    groups:
+      npm-development:
+        dependency-type: development
+        update-types:
+          - minor
+          - patch
+      npm-production:
+        dependency-type: production
+        update-types:
+          - patch

package/.github/prompts/create-release-notes.prompt.md

@@ -0,0 +1,29 @@
+# Create Release Notes
+
+You are an expert technical writer tasked with creating release notes for updates to this repository. Your specific task
+is to generate release notes that are clear, concise, and useful for developers and users of the project.
+
+## Guidelines
+
+Ensure you adhere to the following guidelines when creating release notes:
+
+- Use a clear and consistent format for the release notes
+- Include a summary of the changes made in the release
+- Highlight any new features, improvements, or bugfixes
+- If applicable, include instructions for upgrading or migrating to the new version
+- Use technical language that is appropriate for the audience, but avoid jargon that may not be understood by all users
+- Ensure that the release notes are easy to read and navigate
+- Include relevant issue or PR numbers where applicable
+- Use proper Markdown formatting
+- Use code blocks for commands, configuration examples, or code changes
+- Use note and warning callouts for important information
+
+## Versioning
+
+GitHub Actions are versioned using branch and tag names. The version in the project's `package.json` should reflect the
+changes made in the codebase and follow [Semantic Versioning](https://semver.org/) principles. Depending on the nature
+of the changes, please make sure to adjust the release notes accordingly:
+
+- For **major** changes, include a detailed description of the breaking changes and how users can adapt to them
+- For **minor** changes, highlight new features and improvements
+- For **patch** changes, focus on bugfixes and minor improvements

package/.github/prompts/unit-test.prompt.md

@@ -0,0 +1,77 @@
+# Create Unit Test(s)
+
+You are an expert software engineer tasked with creating unit tests for the repository. Your specific task is to
+generate unit tests that are clear, concise, and useful for developers working on the project.
+
+## Guidelines
+
+Ensure you adhere to the following guidelines when creating unit tests:
+
+- Use a clear and consistent format for the unit tests
+- Include a summary of the functionality being tested
+- Use descriptive test names that clearly convey their purpose
+- Ensure tests cover both the main path of success and edge cases
+- Use proper assertions to validate the expected outcomes
+- Use `jest` for writing and running tests
+- Place unit tests in the `__tests__` directory
+- Use fixtures for any necessary test data, placed in the `__fixtures__` directory
+
+## Example
+
+Use the following as an example of how to structure your unit tests:
+
+```typescript
+/**
+ * Unit tests for the action's main functionality, src/main.ts
+ */
+import { jest } from '@jest/globals';
+import * as core from '../__fixtures__/core.js';
+import { wait } from '../__fixtures__/wait.js';
+
+// Mocks should be declared before the module being tested is imported.
+jest.unstable_mockModule('@actions/core', () => core);
+jest.unstable_mockModule('../src/wait.js', () => ({ wait }));
+
+// The module being tested should be imported dynamically. This ensures that the
+// mocks are used in place of any actual dependencies.
+const { run } = await import('../src/main.js');
+
+describe('main.ts', () => {
+  beforeEach(() => {
+    // Set the action's inputs as return values from core.getInput().
+    core.getInput.mockImplementation(() => '500');
+
+    // Mock the wait function so that it does not actually wait.
+    wait.mockImplementation(() => Promise.resolve('done!'));
+  });
+
+  afterEach(() => {
+    jest.resetAllMocks();
+  });
+
+  it('Sets the time output', async () => {
+    await run();
+
+    // Verify the time output was set.
+    expect(core.setOutput).toHaveBeenNthCalledWith(
+      1,
+      'time',
+      // Simple regex to match a time string in the format HH:MM:SS.
+      expect.stringMatching(/^\d{2}:\d{2}:\d{2}/),
+    );
+  });
+
+  it('Sets a failed status', async () => {
+    // Clear the getInput mock and return an invalid value.
+    core.getInput.mockClear().mockReturnValueOnce('this is not a number');
+
+    // Clear the wait mock and return a rejected promise.
+    wait.mockClear().mockRejectedValueOnce(new Error('milliseconds is not a number'));
+
+    await run();
+
+    // Verify that the action was marked as failed.
+    expect(core.setFailed).toHaveBeenNthCalledWith(1, 'milliseconds is not a number');
+  });
+});
+```

package/.github/rust-ci.ts

@@ -0,0 +1,5 @@
+import { createRustWorkflow } from '@dougefresh/ci';
+
+export default function () {
+  return createRustWorkflow().extra('test-extra', 'echo hello').semver(false).disableSanitizers().build();
+}

package/.github/workflows/action-ci.yml

@@ -0,0 +1,39 @@
+name: test
+on:
+  pull_request:
+    branches:
+      - main
+  push:
+    branches:
+      - main
+permissions:
+  contents: read
+jobs:
+  test-action:
+    name: Actions Test / ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - ${{ vars.RUNNER_ARM64 }}
+    steps:
+      - name: Checkout
+        id: checkout
+        uses: actions/checkout@v6
+      - name: Test Local Action
+        id: test-action
+        uses: ./
+      - name: Print Output
+        id: output
+        shell: bash
+        run: |
+          echo '${{ steps.test-action.outputs.config }}' | jq .
+          packages="${{ fromJSON(steps.test-action.outputs.config).global.packages.Linux }}"
+          echo $packages
+          # pages="${{ fromJSON(steps.test-action.outputs.config).pages.mdbook.if }}"
+
+          # if [ "$pages" != "false" ]; then
+          #   echo "pages should be false"
+          #   exit 1
+          # fi

package/.github/workflows/action-review.yml

@@ -0,0 +1,14 @@
+name: jobtaker
+on:
+  pull_request:
+    types: [opened, synchronize, ready_for_review, reopened]
+permissions:
+  contents: read
+  checks: write
+  pull-requests: write
+  id-token: write
+jobs:
+  jobtaker:
+    name: bot
+    uses: ./.github/workflows/pr-review.yml
+    secrets: inherit

package/.github/workflows/dummy-release.yml

@@ -0,0 +1,32 @@
+name: release
+permissions:
+  contents: write
+  checks: write
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: 'version to release'
+        required: true
+        type: choice
+        default: patch
+        options:
+          - patch
+          - rc
+          - minor
+          - beta
+          - alpha
+          - major
+          - release
+      runner:
+        description: 'Runner to use'
+        required: false
+jobs:
+  releaser:
+    if: false
+    name: release
+    uses: ./.github/workflows/rust-release.yml
+    secrets: inherit
+    with:
+      version: ${{ inputs.version }}
+      package: 'dummy'

package/.github/workflows/dummy-test.yml

@@ -0,0 +1,16 @@
+name: dummy
+permissions:
+  contents: read
+  checks: write
+on:
+  push:
+    branches: [main]
+  pull_request:
+jobs:
+  verify:
+    if: true
+    name: dummy
+    uses: ./.github/workflows/rust.yml
+    secrets: inherit
+    with:
+      runner: ${{ vars.RUNNER }}

package/.github/workflows/pages.yml

@@ -0,0 +1,59 @@
+name: Pages
+permissions:
+  contents: write # To push a branch
+  pages: write # To push to a GitHub Pages site
+  id-token: write # To update the deployment status
+on:
+  workflow_call:
+    inputs:
+      runner:
+        type: string
+        default: ${{ vars.RUNNER }}
+        required: false
+
+jobs:
+  config:
+    runs-on: ubicloud-standard-2
+    name: generate config
+    outputs:
+      config: ${{ steps.merge.outputs.config }}
+    steps:
+      - name: merge
+        id: merge
+        uses: dougefresh/ci/.github/actions/rust-config@main
+        with:
+          git_token: ${{ github.token }}
+          runner: ${{ inputs.runner }}
+  mdbook:
+    runs-on: ubicloud-standard-2
+    needs: ['config']
+    if: ${{ fromJSON(needs.config.outputs.config).pages.mdbook.if }}
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+      # - name: Install latest mdbook
+      #   run: |
+      #     tag=$(curl 'https://api.github.com/repos/rust-lang/mdbook/releases/latest' | jq -r '.tag_name')
+      #     url="https://github.com/rust-lang/mdbook/releases/download/${tag}/mdbook-${tag}-aarch64-unknown-linux-gnu.tar.gz"
+      #     mkdir mdbook
+      #     curl -sSL $url | tar -xz --directory=./mdbook
+      #     echo `pwd`/mdbook >> $GITHUB_PATH
+      - uses: jontze/action-mdbook@v4
+        name: Install mdBook
+        with:
+          token: ${{secrets.GITHUB_TOKEN}}
+      - name: Build Book
+        run: |
+          cd ${{ fromJSON(needs.config.outputs.config).pages.mdbook.path }}
+          ${{ fromJSON(needs.config.outputs.config).pages.mdbook.command }}
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v4
+        with:
+          path: ${{ fromJSON(needs.config.outputs.config).pages.mdbook.path }}/book
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

package/.github/workflows/pr-review.yml

@@ -0,0 +1,93 @@
+name: jobtaker
+on:
+  workflow_call:
+permissions:
+  contents: read
+  checks: write
+  pull-requests: write
+  id-token: write
+jobs:
+
+  config:
+    if: |
+      (github.event_name == 'issue_comment' && contains(github.event.comment.body, '@jobtaker')) ||
+      (github.event_name == 'pull_request_review_comment' && contains(github.event.comment.body, '@jobtaker')) ||
+      (github.event_name == 'pull_request_review' && contains(github.event.review.body, '@jobtaker')) ||
+      (contains(github.event.pull_request.labels.*.name, 'jobtaker')) ||
+      (github.event_name == 'issues' && (contains(github.event.issue.body, '@jobtaker') || contains(github.event.issue.title, '@jobtaker')))
+    runs-on: ${{ inputs.runner || vars.RUNNER }}
+    name: generate config
+    outputs:
+      config: ${{ steps.config.outputs.config }}
+    steps:
+      - name: Validate ANTHROPIC_API_KEY
+        shell: bash
+        run: |
+          if [ -z "${{ secrets.ANTHROPIC_API_KEY }}" ]; then
+            exit 1
+          fi
+      - name: config
+        id: config
+        uses: dougefresh/ci/.github/actions/rust-config@main
+        with:
+          arm64: ${{ vars.RUNNER_ARM64 }}
+          amd64: ${{ vars.RUNNER_AMD64 }}
+          git_token: ${{ github.token }}
+  jobtaker:
+    needs:  [config]
+    if: |
+      (github.event_name == 'issue_comment' && contains(github.event.comment.body, '@jobtaker')) ||
+      (github.event_name == 'pull_request_review_comment' && contains(github.event.comment.body, '@jobtaker')) ||
+      (github.event_name == 'pull_request_review' && contains(github.event.review.body, '@jobtaker')) ||
+      (contains(github.event.pull_request.labels.*.name, 'jobtaker')) ||
+      (github.event_name == 'issues' && (contains(github.event.issue.body, '@jobtaker') || contains(github.event.issue.title, '@jobtaker')))
+    runs-on: ${{ vars.RUNNER }}
+    steps:
+      - name: checkout
+        uses: dougefresh/ci/.github/actions/rust-init@main
+        with:
+          packages: ${{ toJSON(fromJSON(needs.config.outputs.config).global.packages) }}
+      - name: jobtaker
+        if: ${{ fromJSON(needs.config.outputs.config).ai.enabled }}
+        uses: anthropics/claude-code-action@v1
+        with:
+          anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
+          trigger_phrase: '@jobtaker'
+          # settings: ${{ toJSON(fromJSON(needs.config.outputs.config).ai.settings) }}
+          #            description: "Claude Code settings as JSON string or path to settings JSON file"
+          allowed_bots: ${{ fromJSON(needs.config.outputs.config).ai.allowed_bots }}
+          #            description: "Comma-separated list of allowed bot usernames, or '*' to allow all bots. Empty string (default) allows no bots."
+          # Your custom review instructions
+          prompt: |
+            REPO: ${{ github.repository }}
+            PR NUMBER: ${{ github.event.pull_request.number }}
+
+            ${{ fromJSON(needs.config.outputs.config).ai.prompt }}
+
+            ---
+
+            ${{ fromJSON(needs.config.outputs.config).ai.additional }}
+          # Tools for comprehensive PR review
+          claude_args: ${{ fromJSON(needs.config.outputs.config).ai.claude_args }}
+          use_sticky_comment: ${{ fromJSON(needs.config.outputs.config).ai.use_sticky_comment }}
+          # description: "Use just one comment to deliver issue/PR comments"
+          # required: false
+          # default: "false"
+          track_progress: "${{ fromJSON(needs.config.outputs.config).ai.track_progress }}"
+          #            description: "Force tag mode with tracking comments for pull_request and issue events. Only applicable to pull_request (opened, synchronize, ready_for_review, reopened) and issue (opened, edited, labeled, assigned) events."
+          path_to_claude_code_executable: ''
+          #           description: "Optional path to a custom Claude Code executable. If provided, skips automatic installation and uses this executable instead. WARNING: Using an older version may cause problems if the action begins taking advantage of new Claude Code features. This input is typically not needed unless you're debugging something specific or have unique needs in your environment."
+          path_to_bun_executable: ''
+          #            description: "Optional path to a custom Bun executable. If provided, skips automatic Bun installation and uses this executable instead. WARNING: Using an incompatible version may cause problems if the action requires specific Bun features. This input is typically not needed unless you're debugging something specific or have unique needs in your environment."
+          show_full_output: 'false'
+          #            description: "Show full JSON output from Claude Code. WARNING: This outputs ALL Claude messages including tool execution results which may contain secrets, API keys, or other sensitive information. These logs are publicly visible in GitHub Actions. Only enable for debugging in non-sensitive environments."
+          plugins: ''
+          #           description: "Newline-separated list of Claude Code plugin names to install (e.g., 'code-review@claude-code-plugins\nfeature-dev@claude-code-plugins')"
+          plugin_marketplaces: ''
+#            description: "Newline-separated list of Claude Code plugin marketplace Git URLs to install from (e.g., 'https://github.com/user/marketplace1.git\nhttps://github.com/user/marketplace2.git')"
+
+# When track_progress is enabled:
+# - Creates a tracking comment with progress checkboxes
+# - Includes all PR context (comments, attachments, images)
+# - Updates progress as the review proceeds
+# - Marks as completed when done

package/.github/workflows/release.yml

@@ -0,0 +1,41 @@
+name: ci lib release
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+
+jobs:
+  release:
+    runs-on: ${{ vars.RUNNER }}
+    permissions:
+      contents: write
+      packages: write
+    steps:
+      - uses: actions/checkout@v6
+
+      - uses: oven-sh/setup-bun@v2
+
+      - name: Configure npm registry
+        run: |
+          echo "//registry.npmjs.org/:_authToken=${{ secrets.NPM_TOKEN }}" > .npmrc
+      - name: Build
+        run: bun run build
+      - name: Get version
+        id: version
+        run: echo "tag=$(jq -r .version package.json)" >> $GITHUB_OUTPUT
+
+      - name: Publish to GitHub Packages
+        run: bun publish
+
+      # - name: Publish to npm
+        # run: npm publish --access public
+
+      - uses: softprops/action-gh-release@v2
+        name: publish
+        with:
+          tag_name: ${{ steps.version.outputs.tag }}
+          generate_release_notes: true