Skip to content

Commit 13c18c4

Browse files
chore(subgraph): clean outdated readme
1 parent 11347a1 commit 13c18c4

File tree

1 file changed

+6
-16
lines changed

1 file changed

+6
-16
lines changed

packages/subgraph/README.md

Lines changed: 6 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -36,36 +36,25 @@ To deploy this subgraph on Thegraph network:
3636

3737
3. Deploy: `npx graph deploy <slug> --network <name>`
3838

39-
4039
### Hosted Production Environments
4140

4241
We use CI/CD pipelines to deploy our subgraphs to hosted environments.
4342

44-
#### Docker Image Tags
45-
46-
When building and pushing Docker images, the following tag generation strategy is used:
47-
48-
| Trigger | Environment | Tag Format | Example | Push? |
49-
|---------|-------------|------------|---------|-------|
50-
| Manual workflow dispatch | Production | `{package.json version}` | `1.2.3` | Yes |
51-
| Manual workflow dispatch | Development | `dev-{commit SHA}` | `dev-8e7d3f2` | Yes |
52-
| Push to `main` branch | Production | `{package.json version}` | `1.2.3` | Yes |
53-
| Push to `develop` branch | Development | `dev-{commit SHA}` | `dev-8e7d3f2` | Yes |
54-
| Tag push | N/A | `{tag name}` | `v1.2.3-beta` | Yes |
55-
| Other branch push | Development | `dev-{commit SHA}` | `dev-8e7d3f2` | No |
56-
5743
### Self-Hosted Subgraph Deployment Process
5844

5945
For zero-downtime updates to the production subgraph:
6046

6147
1. **Index the New Version (Temporary Deployment)**
48+
6249
- Trigger deployment with target: `subgraph-deploy-tmp`
6350
- This creates a separate instance for indexing
6451

6552
2. **Wait for Indexing Completion**
53+
6654
- Monitor the temporary deployment until it's fully synced
6755

6856
3. **Deploy to Production (Zero Downtime)**
57+
6958
- Once temporary deployment is ready, trigger: `subgraph-deploy-prod`
7059
- This swaps the deployments with no service interruption
7160

@@ -79,7 +68,7 @@ For zero-downtime updates to the production subgraph:
7968
```graphql
8069
query MyQuery($requiredSchema: [String!]!, $start: Int!, $range: Int!) {
8170
protectedDatas(
82-
where: {transactionHash_not: "0x", schema_contains: $requiredSchema}
71+
where: { transactionHash_not: "0x", schema_contains: $requiredSchema }
8372
skip: $start
8473
first: $range
8574
orderBy: creationTimestamp
@@ -126,6 +115,7 @@ query MyQuery($requiredSchema: [String!]!, $start: Int!, $range: Int!) {
126115
## CI/CD Integration
127116

128117
Our repository uses automated workflows to build, test, and deploy the subgraph:
118+
129119
- ABI validation checks ensure contract ABIs are up-to-date
130120
- Docker images are built and pushed with appropriate tags based on the source branch
131-
- Deployment follows a staged approach to ensure zero downtime
121+
- Deployment follows a staged approach to ensure zero downtime

0 commit comments

Comments
 (0)