Skip to content

Commit 8bfa39f

Browse files
committed
Add instructions for claude
1 parent db39ac7 commit 8bfa39f

1 file changed

Lines changed: 28 additions & 0 deletions

File tree

CLAUDE.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Workspace Instructions
2+
3+
## Vendored Library Flow
4+
5+
This repository uses a proprietary caching library: `gradle-actions-caching`.
6+
7+
- The vendored copy lives at `sources/vendor/gradle-actions-caching`
8+
- The source code is at `../actions-caching` and https://github.com/gradle/actions-caching
9+
10+
When a task involves building, updating, validating, or testing the vendored `gradle-actions-caching` library, use this sequence:
11+
12+
1. Run `npm run build` in `actions-caching`.
13+
2. Copy (overwrite) the contents of `actions-caching/dist/` onto `sources/vendor/gradle-actions-caching/`. (No need to rm the existing contents)
14+
3. Then continue with any build, test, or validation steps in this repository.
15+
16+
Do not treat `actions/sources/vendor/gradle-actions-caching` as the source of truth. The source of truth is `actions-caching`, and the vendor directory must be refreshed from its `dist/` output after rebuilding.
17+
18+
## Building
19+
20+
To build this repository, run the `build` script at the root of that repository with no arguments:
21+
22+
```sh
23+
./build
24+
```
25+
26+
## dist directory
27+
28+
Never make direct changes to the 'dist' directory. Building with npm will populate 'sources/dist' which is enough. There is a CI workflow that will update the 'dist' directory when required.

0 commit comments

Comments
 (0)