Skip to content

docs: clarify CMS sync automation #128

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rossgalloway wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: clarify CMS sync automation #128

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 15 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,27 +42,31 @@ URL = http://127.0.0.1:3000

`VITE_GITHUB_REDIRECT_URI` tells GitHub to redirect to your local dev server port. GitHub allows any port on `127.0.0.1` as long as the registered callback URL uses the same host. Leave it unset in production.

#### Manual vault and strategy sync
```bash

act -j sync-vaults
# see https://github.com/nektos/act
#### Vault, strategy, and token sync

```
Automatic sync runs from `.github/workflows/sync.yml` every hour and on manual dispatch.

or
- `packages/app/scripts/sync-vaults.ts` queries Kong GraphQL at `https://kong.yearn.fi/api/gql` using `vaults(yearn: true)`.
- New vaults are detected by lowercased address and appended to `packages/cdn/vaults/<chainId>.json`.
- `packages/app/scripts/sync-strategies.ts` and `packages/app/scripts/sync-tokens.ts` do the same for strategies and tokens.
- The workflow commits and pushes only when something under `packages/cdn/` changed.

To trigger the same workflow locally with `act`:
```bash
act -j sync-vaults-and-strategies
# see https://github.com/nektos/act
```

To run the sync scripts directly:
```bash
bun packages/app/scripts/sync-vaults.ts
bun packages/app/scripts/sync-strategies.ts
bun packages/app/scripts/sync-tokens.ts
git add packages/app/cdn/vaults
git add packages/app/cdn/strategies
git add packages/app/cdn/tokens
git add packages/cdn/vaults
git add packages/cdn/strategies
git add packages/cdn/tokens
git commit -m 'Sync vaults strategies and tokens'
git push

```

### cdn url
Expand Down