Skip to main content

Local read-only scanner for GitHub Actions deprecation and runtime migration risks.

Project description

GitHub Actions Deprecation Preflight

Local read-only prototype that scans GitHub Actions workflow files, local JavaScript action metadata, and Markdown snippets for known deprecation/runtime migration risks.

Current v1 scope

  • actions/upload-artifact@v3 and actions/download-artifact@v3
  • actions/cache@v3, actions/checkout@v3, actions/setup-node@v3 review signals
  • local action.yml / action.yaml runs.using: node16 runtime risk
  • optional low-severity review signal for runs.using: node20

No GitHub API, tokens, accounts, or network calls are used.

Try locally

python3 scanner.py examples
python3 scanner.py examples --format json
python3 scanner.py examples --output report.md
python3 scanner.py examples --fail-on-severity high
python3 scanner.py examples --min-severity high
python3 scanner.py examples --only-rule upload-artifact-v3
python3 scanner.py --list-rules
python3 scanner.py --list-rules --format json
python3 scanner.py examples --ignore-rule local-action-node20-review

Example output:

# GitHub Actions Deprecation Preflight

Scanned files: 3
Active rules: 7
Findings: 6

CI usage

See docs/CI_USAGE.md for report-only, high-risk gate, and scoped rollout examples.

Intended workflow

  1. Run the scanner at a repository root.
  2. Review high-severity findings first, especially retired artifact actions and old local JavaScript runtimes.
  3. Use --min-severity high for a high-risk-only report, --only-rule while validating one migration family, or --ignore-rule for a documented false-positive/noise window.
  4. Upgrade action majors on a branch.
  5. Verify workflow behavior before merging.

Safety notes

  • The scanner is read-only.
  • It does not upload workflow contents.
  • It does not need a GitHub token.
  • It does not make automatic migrations.
  • CI failure is opt-in via --fail-on-severity.
  • Rule filtering is explicit and local; unknown rule ids fail fast instead of silently changing coverage.
  • --list-rules can be used to review active rule coverage before adding the scanner to CI.

Roadmap

  • Expand the rule inventory as GitHub Actions deprecations change.
  • Add more fixtures for common workflow patterns.
  • Expand CI adoption examples and release notes.
  • Keep the default mode deterministic, local, and read-only.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

github_actions_deprecation_preflight-0.1.1.tar.gz (8.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file github_actions_deprecation_preflight-0.1.1.tar.gz.

File metadata

File hashes

Hashes for github_actions_deprecation_preflight-0.1.1.tar.gz
Algorithm Hash digest
SHA256 217a0dadc85515531bcfdd38abfecd28327979201024909963009054bd277605
MD5 03805a7700d2271fc97d8d65b5a98375
BLAKE2b-256 b7907ec74e49864261eb04515311b9414c9956be500af38c831e8f781a86d7b6

See more details on using hashes here.

Provenance

The following attestation bundles were made for github_actions_deprecation_preflight-0.1.1.tar.gz:

Publisher: publish.yml on vasiliy0/github-actions-deprecation-preflight

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file github_actions_deprecation_preflight-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for github_actions_deprecation_preflight-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 51aabff596bac25cd59023109c1fc3ce8ab009b14fc97b9a46a903b425bce057
MD5 f021fb099a5fc18c41a47a9d86508c8f
BLAKE2b-256 d8c853d6da5cf4a30e729262273bbfa7be98fb4676b81f18d4792cb0aaad4f4f

See more details on using hashes here.

Provenance

The following attestation bundles were made for github_actions_deprecation_preflight-0.1.1-py3-none-any.whl:

Publisher: publish.yml on vasiliy0/github-actions-deprecation-preflight

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page