feat(docs): add workflow to sync contract addresses from upstream#578
feat(docs): add workflow to sync contract addresses from upstream#578
Conversation
- Add script to fetch addresses from FilOzone/filecoin-services deployments.json - Add GitHub workflow: fails PR CI if outdated, auto-creates PR on schedule - Update contracts.md with proxy/implementation addresses - Show only changed addresses in script output
Deploying with
|
| Status | Name | Latest Commit | Preview URL | Updated (UTC) |
|---|---|---|---|---|
| ✅ Deployment successful! View logs |
synapse-dev | 522bc2d | Commit Preview URL Branch Preview URL |
Jan 30 2026, 02:33 PM |
rvagg
left a comment
There was a problem hiding this comment.
See #567 for a fuller set of concerns and discussion about this topic. Some initial feedback from me:
-
Although that issue is concerned with SDK contract addresses, they should be in sync with the docs. This PR only syncs contracts.md from deployments.json. After this PR we would have two mechanisms for updating contract addresses and that's a no-go.
-
This PR also just fetches from
mainindiscriminantly, that's not necessarily the contracts we want to be publishing here, we probably want to be more intentional and either fetch from the GH releases API, or use repository_dispatch from filecoin-services to come back here. The metadata.commit field in deployments.json could help here if we go the releases route. -
The failure mode I talked about in #567 is a concern and this PR suffers from it. Unrelated work is going to be held up just because there's a new deployments.json, creating hassle and confusion.
I think there's a few paths forward here, but whatever we do we need to integrate both code & docs. First thing might be to sync the docs from generated.ts, so wagmi.config.ts is the one source of truth here. Second, we need a trigger to perform updates here in a way that doesn't hold up unrelated work. I'm partial to the release trigger on filecoin-services creating a PR to this repo to do the update, but see #567 for other options, or discuss sync in one of the team meetings with @hugomrdias || me.
|
@rvagg what about making sure that docs are always synced with the addresses inside the latest version of the sdk ? If that's a path to move forward this should be the same CI in filecoin.cloud which now syncs using filecoin-services deployments.json |
@nijoe1 : I think that is what @rvagg is suggesting with this statement "First thing might be to sync the docs from generated.ts, so wagmi.config.ts is the one source of truth here.". I think that makes sense to do for now because then we have one place in Synapse that needs to get updated. #567 is there to track automating the contract versions that Synapse uses, which I agree can come post GA. |
|
yep docs should be in sync with keeping |
Related: FilOzone/filecoin-cloud#217
cc: @BigLep