Skip to content

Commit 0555350

Browse files
authored
feat(ci): Add README.md to contracts and fix helm package contract (#733)
Signed-off-by: Javier Rodriguez <[email protected]>
1 parent 578e0c5 commit 0555350

File tree

2 files changed

+22
-0
lines changed

2 files changed

+22
-0
lines changed
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
## Chainloop contracts
2+
3+
In this folder all contracts of Chainloop repository are kept as a reference and are the source of truth.
4+
5+
On every push to the `main` branch of the repository, all files contained in `.github/workflows/contracts`
6+
are updated regardless if they have changed or not. No worries, Chainloop can detect if the file has changed or not
7+
and update the revision accordingly.
8+
9+
Additionally, the contracts are being updated every day at midnight UTC.
10+
11+
All logic is behind handled by the GitHub action `.github/workflows/sync_contracts.yml`.
12+
13+
### Important note
14+
The name of the files in `.github/workflows/contracts` should be the same as the contract name since
15+
it's used for its update. Example:
16+
- Contract name: `chainloop-deploy`
17+
- File name: `chainloop-deploy.yml`
18+
19+
Generated update command:
20+
```bash
21+
$ chainloop wf contract update --name chainloop-deploy --contract .github/workflows/contracts/chainloop-deploy.yml
22+
```

.github/workflows/contracts/chainloop-helm-pacakge.yml renamed to .github/workflows/contracts/chainloop-helm-package.yml

File renamed without changes.

0 commit comments

Comments
 (0)