Add support for @actions/cache #217
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- 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.
Semantic Version Check Passed ✅Version in manifest file This comment will be automatically updated as changes are pushed to this PR branch. |
Contributor
There was a problem hiding this comment.
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/cachepackage with local filesystem-based caching functionality - Major overhaul of
.env.examplewith 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 <[email protected]>
🦙 MegaLinter status: ✅ SUCCESS
See detailed report in MegaLinter reports
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request introduces support for the
@actions/cachepackage for local testing, enhances the.env.examplefile 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:
@actions/cachepackage, enabling local caching of dependencies and files between runs by requiring theLOCAL_ACTION_CACHE_PATHenvironment variable. Also clarified requirements for@actions/artifactand@actions/cachein the changelog..env.exampleto include detailed documentation, default values, and grouping of variables for@github/local-action, GitHub Actions inputs, and runner/environment variables. Added new variables such asLOCAL_ACTION_CACHE_PATH,LOCAL_ACTION_WORKSPACE, and provided more explicit defaults for local testing.Documentation and toolkit stub management:
CONTRIBUTING.mdfor updating toolkit stubs, including how to track reviewed versions and compare toolkit package changes, to ensure consistency and easier maintenance.@actions/githubin theREADME.mdfrom6.0.0to6.0.1.Testing and stub improvements:
@actions/ioin__fixtures__/@actions/io.tsfor use in tests, implementing mock versions ofwhichandmkdirP.isDebugto the@actions/coretest fixture.