Skip to content
packagetrack-devPublic

About

Push your build's dependency set to PackageTrack from CI

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

1 Commit

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 

Repository files navigation

PackageTrack Action

Pushes the dependency set of a build to PackageTrack from GitHub Actions.

Usage

- uses: packagetrack-dev/action@v1
  with:
    api-key: ${{ secrets.PACKAGETRACK_API_KEY }}

Create an API key at packagetrack.dev/app/keys and store it as a repository secret.

Inputs

Input Default Description
api-key required PackageTrack API key.
project . Directory containing the lock file.
name directory name Project name in PackageTrack.
ecosystem all pypi or npm, to read only one lock file type.
server https://packagetrack.dev Server URL, for self-hosted installs.
dry-run false Print the payload and send nothing. No key needed.

Examples

Monorepo, one project per lock file:

- uses: packagetrack-dev/action@v1
  with:
    api-key: ${{ secrets.PACKAGETRACK_API_KEY }}
    project: services/api
    name: api
- uses: packagetrack-dev/action@v1
  with:
    api-key: ${{ secrets.PACKAGETRACK_API_KEY }}
    project: apps/web
    name: web

Run on lock file changes and on a weekly schedule:

on:
  push:
    branches: [main]
    paths: ["**/uv.lock", "**/package-lock.json", "**/requirements.txt"]
  schedule:
    - cron: "0 6 * * 1"

Behavior

The action installs packagetrackdev with install.sh and runs packagetrackdev push. The payload is package names, versions and their parent packages; no source code or file paths. Use dry-run: true to see it in the log.

Outdated dependencies do not fail the step. It fails only when the push itself cannot be made: missing key, no lock file, or the server unreachable.

License

MIT

About

Push your build's dependency set to PackageTrack from CI

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors