Skip to content

Scaffold GitHub Action for covdbg setup on Windows - #1

Merged
svnscha merged 6 commits into
mainfrom
copilot/scaffold-covdbg-action
Jan 25, 2026
Merged

svnscha merged 6 commits into
mainfrom
copilot/scaffold-covdbg-action

Conversation

Copilot AI commented Jan 25, 2026 •

Copy link
Copy Markdown

Implements a GitHub Action that downloads, caches, and configures covdbg CLI on Windows runners using a user-specified version.

Implementation

Action structure

  • TypeScript implementation using @actions/core and @actions/tool-cache
  • Bundles to single dist/index.js via @vercel/ncc
  • Node.js 20 runtime
  • dist/ directory excluded from git (not tracked in repository)

Core logic (src/main.ts)

  • Currently using test URL https://downloads.covdbg.com/21321662162/covdbg.zip for development testing
  • Production URLs commented out (will use https://covdbg.com/download/{version}/portable when testing is complete)
  • Supports both specific versions (e.g., 1.0.0) and latest (ready for production)
  • Downloads covdbg.zip containing covdbg.exe and libcovdbg.dll
  • Extracts zip, caches via tc.cacheDir(), adds to PATH via core.addPath()
  • Platform validation enforces Windows-only (win32)
  • Returns installation path as covdbg-path output

Configuration (action.yml)

  • Input: version (required, semver string or 'latest')
  • Output: covdbg-path (installation directory)

Usage

- uses: covdbg/setup-covdbg@v1
  with:
    version: 'latest'
    
- run: covdbg --version

Files Added

  • src/main.ts - Action implementation
  • action.yml - Action metadata
  • .gitignore - Excludes dist/, node_modules/, lib/
  • README.md - Usage documentation
  • .github/workflows/test.yml - Example workflow with build steps

Development

Since dist/ is not committed, contributors must build the action locally:

npm install
npm run package

Note: The action currently uses a test URL for development. Production URLs are commented out in the code and will be enabled after testing is complete.

Original prompt

Scaffold a new GitHub action that is able to download and setup covdbg on Windows runners. Examples:

The following script demonstrates how you can get a user-specified version as input, download and extract the specific version of your CLI, then add the CLI to the path.

GitHub provides actions/toolkit, which is a set of packages that helps you create actions. This example uses the actions/core and actions/tool-cache packages.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI and others added 3 commits January 25, 2026 20:13
Co-authored-by: svnscha <24257042+svnscha@users.noreply.github.com>
Co-authored-by: svnscha <24257042+svnscha@users.noreply.github.com>
Co-authored-by: svnscha <24257042+svnscha@users.noreply.github.com>
Copilot AI changed the title [WIP] Add new GitHub action to setup covdbg on Windows Scaffold GitHub Action for covdbg setup on Windows Jan 25, 2026
Copilot AI requested a review from svnscha January 25, 2026 20:17
@svnscha

svnscha commented Jan 25, 2026

Copy link
Copy Markdown
Contributor

@copilot

  1. Put dist/ to .gitignore. The URLs are:
  2. https://covdbg.com/download/latest/portable is the latest version it downloads a covdbg.zip including covdbg.exe and libcovdbg.dll. Both must be put to a directory which must be added to PATH.

- Add dist/ to .gitignore (no longer tracked in git)
- Update download URL to use https://covdbg.com/download/{version}/portable
- Support 'latest' version for downloading the latest portable release
- Update documentation to reflect new URL and build requirements
- Update test workflow to build action before testing

Co-authored-by: svnscha <24257042+svnscha@users.noreply.github.com>

Copilot AI commented Jan 25, 2026

Copy link
Copy Markdown
Author

@copilot

  1. Put dist/ to .gitignore. The URLs are:
    ...

Done in 28cb3ac.

Changes made:

  1. Added dist/ to .gitignore - dist files are no longer tracked in git
  2. Updated download URL to use https://covdbg.com/download/{version}/portable (supports both specific versions and 'latest')
  3. Updated comments to clarify that covdbg.zip contains both covdbg.exe and libcovdbg.dll
  4. Updated test workflow to build the action before testing

@svnscha
svnscha marked this pull request as ready for review January 25, 2026 20:46
@svnscha

svnscha commented Jan 25, 2026

Copy link
Copy Markdown
Contributor

@copilot For testing (right now as this action is in development) comment out the regular URLs and always use: downloads.covdbg.com/21321662162/covdbg.zip.

- Comment out production URLs
- Use temporary test URL: downloads.covdbg.com/21321662162/covdbg.zip
- Add TODO comment to uncomment production URLs after testing

Co-authored-by: svnscha <24257042+svnscha@users.noreply.github.com>

Copilot AI commented Jan 25, 2026

Copy link
Copy Markdown
Author

@copilot For testing (right now as this action is in development) comment out the regular URLs and always use: downloads.covdbg.com/21321662162/covdbg.zip.

Done in 25ebf6d.

Changes made:

  • Commented out the production URLs (covdbg.com/download paths)
  • Now using test URL: https://downloads.covdbg.com/21321662162/covdbg.zip
  • Added TODO comment to remind to uncomment production URLs after testing is complete

@svnscha
svnscha merged commit 3a671cf into main Jan 25, 2026
1 check passed
@svnscha
svnscha deleted the copilot/scaffold-covdbg-action branch January 25, 2026 22:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants