Skip to content

Add support for @actions/cache#217

Merged
ncalteen merged 7 commits intomainfrom
ncalteen/review
Sep 11, 2025
Merged

Add support for @actions/cache#217
ncalteen merged 7 commits intomainfrom
ncalteen/review

Conversation

@ncalteen
Copy link
Copy Markdown
Collaborator

This pull request introduces support for the @actions/cache package for local testing, enhances the .env.example file with more comprehensive documentation and variables, and updates documentation to reflect these changes. It also adds new test stubs and minor version bumps for toolkit dependencies.

Local caching and environment variable enhancements:

  • Added support for the @actions/cache package, enabling local caching of dependencies and files between runs by requiring the LOCAL_ACTION_CACHE_PATH environment variable. Also clarified requirements for @actions/artifact and @actions/cache in the changelog.
  • Major overhaul of .env.example to include detailed documentation, default values, and grouping of variables for @github/local-action, GitHub Actions inputs, and runner/environment variables. Added new variables such as LOCAL_ACTION_CACHE_PATH, LOCAL_ACTION_WORKSPACE, and provided more explicit defaults for local testing.

Documentation and toolkit stub management:

  • Added instructions in CONTRIBUTING.md for updating toolkit stubs, including how to track reviewed versions and compare toolkit package changes, to ensure consistency and easier maintenance.
  • Updated the supported version of @actions/github in the README.md from 6.0.0 to 6.0.1.

Testing and stub improvements:

  • Added a stub for @actions/io in __fixtures__/@actions/io.ts for use in tests, implementing mock versions of which and mkdirP.
  • Added a stub for isDebug to the @actions/core test fixture.

- Updated the version of `@actions/github` from `6.0.0` to `6.0.1` in package.json and package-lock.json.
- Updated the version of `@octokit/core` from `6.1.5` to `7.0.3` in package.json and package-lock.json.
- Updated various dependencies in package-lock.json to their latest versions.
- Updated the last reviewed commit references and dates in all relevant stub files to reflect the latest changes in the GitHub Actions Toolkit.
@ncalteen ncalteen self-assigned this Sep 11, 2025
Copilot AI review requested due to automatic review settings September 11, 2025 19:26
@github-actions
Copy link
Copy Markdown

Semantic Version Check Passed ✅

Version in manifest file package.json is valid.

This comment will be automatically updated as changes are pushed to this PR branch.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This pull request introduces support for the @actions/cache package for local testing, enhances the .env.example file with more comprehensive documentation and variables, and updates documentation to reflect these changes. It also adds new test stubs and minor version bumps for toolkit dependencies.

  • Add support for @actions/cache package with local filesystem-based caching functionality
  • Major overhaul of .env.example with detailed documentation and environment variable grouping
  • Documentation updates including instructions for toolkit stub management and supported version updates

Reviewed Changes

Copilot reviewed 49 out of 50 changed files in this pull request and generated 6 comments.

Show a summary per file
File Description
src/types.ts Add caches property to EnvMetadata type
src/stubs/env.ts Initialize caches property in environment metadata
src/stubs/cache/ Complete implementation of cache stub functionality
src/commands/run.ts Integrate cache stubs and populate existing caches from filesystem
package.json Update dependencies and version bump to 6.0.0
.env.example Comprehensive documentation and reorganization of environment variables
docs/ Update supported functionality documentation
tests/ Add comprehensive test coverage for cache functionality
fixtures/ Add new test fixtures for @actions/io and fs mocking

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@github-actions
Copy link
Copy Markdown

🦙 MegaLinter status: ✅ SUCCESS

Descriptor Linter Files Fixed Errors Warnings Elapsed time
✅ ACTION actionlint 5 0 0 0.15s
✅ JAVASCRIPT prettier 19 0 0 1.11s
✅ JSON npm-package-json-lint yes no no 0.6s
✅ JSON prettier 31 0 0 3.74s
✅ MARKDOWN markdownlint 10 0 0 1.16s
✅ REPOSITORY checkov yes no no 22.64s
✅ REPOSITORY gitleaks yes no no 1.4s
✅ REPOSITORY git_diff yes no no 0.02s
✅ REPOSITORY grype yes no no 46.0s
✅ REPOSITORY secretlint yes no no 1.09s
✅ REPOSITORY syft yes no no 7.33s
✅ REPOSITORY trivy yes no no 11.36s
✅ REPOSITORY trivy-sbom yes no no 6.29s
✅ REPOSITORY trufflehog yes no no 30.35s
✅ TYPESCRIPT prettier 109 0 0 5.0s
✅ YAML prettier 25 0 0 0.91s
✅ YAML yamllint 25 0 0 1.04s

See detailed report in MegaLinter reports

MegaLinter is graciously provided by OX Security

@ncalteen ncalteen merged commit 0f3e401 into main Sep 11, 2025
14 checks passed
@ncalteen ncalteen deleted the ncalteen/review branch September 11, 2025 19:33
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