Skip to content

Commit 01ad6f9

Browse files
author
tazhate
committed
fix(ci): remove v1 issues section from golangci.yml; move Quick Start before Architecture in README
1 parent 49db691 commit 01ad6f9

2 files changed

Lines changed: 72 additions & 96 deletions

File tree

.golangci.yml

Lines changed: 7 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -51,39 +51,15 @@ linters:
5151
- copyloopvar
5252
- prealloc
5353
- staticcheck
54+
- path: "test/"
55+
linters:
56+
- revive
57+
- path: "_test\\.go"
58+
text: "dot-imports"
59+
linters:
60+
- revive
5461

5562
formatters:
5663
enable:
5764
- gofmt
5865
- goimports
59-
60-
# v1-compatible exclusion rules (mirror of linters.exclusions above).
61-
# golangci-lint v1.x ignores linters.exclusions — this section keeps
62-
# identical rules working on both v1 and v2 installations.
63-
issues:
64-
exclude-rules:
65-
- path: "api/"
66-
linters:
67-
- lll
68-
- path: "internal/"
69-
linters:
70-
- dupl
71-
- lll
72-
- goconst
73-
- gocyclo
74-
- path: "_test\\.go"
75-
linters:
76-
- goconst
77-
- errcheck
78-
- dupl
79-
- unparam
80-
- copyloopvar
81-
- prealloc
82-
- staticcheck
83-
- path: "test/"
84-
linters:
85-
- revive
86-
- path: "_test\\.go"
87-
text: "dot-imports"
88-
linters:
89-
- revive

README.md

Lines changed: 65 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,71 @@ spec:
5353
- **Webhook validation** — admission webhook enforces minimum storage/memory requirements and immutable chain/network fields
5454
- **Sidecars** — attach consensus-layer clients (e.g. Lighthouse for Ethereum) or any helper process
5555

56+
## Quick Start
57+
58+
### Prerequisites
59+
60+
- Go 1.23+
61+
- kubectl 1.25+
62+
- Access to a Kubernetes cluster
63+
64+
### Install via Helm
65+
66+
```sh
67+
helm install chainplane charts/chainplane \
68+
--namespace blockchain-nodes \
69+
--create-namespace \
70+
--set image.repository=ghcr.io/tazhate/chainplane \
71+
--set image.tag=latest
72+
```
73+
74+
### Install CRDs manually
75+
76+
```sh
77+
make install
78+
make deploy IMG=<your-registry>/chainplane:latest
79+
```
80+
81+
### Create Your First Node
82+
83+
```yaml
84+
apiVersion: nodes.chainplane.io/v1alpha1
85+
kind: BlockchainNode
86+
metadata:
87+
name: bitcoin-mainnet
88+
namespace: blockchain-nodes
89+
spec:
90+
chain: bitcoin
91+
network: mainnet
92+
nodeType: rpc
93+
nodeGroup: heavy
94+
storage:
95+
size: 600Gi
96+
storageClass: fast-nvme
97+
resources:
98+
requests:
99+
cpu: "2"
100+
memory: 8Gi
101+
limits:
102+
cpu: "4"
103+
memory: 16Gi
104+
rpc:
105+
enabled: true
106+
port: 8332
107+
```
108+
109+
```sh
110+
kubectl apply -f bitcoin-node.yaml
111+
kubectl get blockchainnodes -w
112+
```
113+
114+
```
115+
NAME CHAIN NETWORK TYPE PHASE HEIGHT PEERS SYNC ETA
116+
bitcoin-mainnet bitcoin mainnet rpc Syncing 830241 12 73.2% 14h22m
117+
```
118+
119+
Sample manifests for all 102 chains are in [`config/samples/`](config/samples/).
120+
56121
## Architecture
57122
58123
```
@@ -245,71 +310,6 @@ All Cosmos chains use `--home /data` for snapshot compatibility.
245310
| `filecoin` | `filecoin/lotus:v1.35.0` | 1234 | |
246311
| `fantom` | `fantomfoundation/go-opera:v1.1.3-txtracing` | 18545 | |
247312
248-
## Quick Start
249-
250-
### Prerequisites
251-
252-
- Go 1.23+
253-
- kubectl 1.25+
254-
- Access to a Kubernetes cluster
255-
256-
### Install via Helm
257-
258-
```sh
259-
helm install chainplane charts/chainplane \
260-
--namespace blockchain-nodes \
261-
--create-namespace \
262-
--set image.repository=ghcr.io/tazhate/chainplane \
263-
--set image.tag=latest
264-
```
265-
266-
### Install CRDs manually
267-
268-
```sh
269-
make install
270-
make deploy IMG=<your-registry>/chainplane:latest
271-
```
272-
273-
### Create Your First Node
274-
275-
```yaml
276-
apiVersion: nodes.chainplane.io/v1alpha1
277-
kind: BlockchainNode
278-
metadata:
279-
name: bitcoin-mainnet
280-
namespace: blockchain-nodes
281-
spec:
282-
chain: bitcoin
283-
network: mainnet
284-
nodeType: rpc
285-
nodeGroup: heavy
286-
storage:
287-
size: 600Gi
288-
storageClass: fast-nvme
289-
resources:
290-
requests:
291-
cpu: "2"
292-
memory: 8Gi
293-
limits:
294-
cpu: "4"
295-
memory: 16Gi
296-
rpc:
297-
enabled: true
298-
port: 8332
299-
```
300-
301-
```sh
302-
kubectl apply -f bitcoin-node.yaml
303-
kubectl get blockchainnodes -w
304-
```
305-
306-
```
307-
NAME CHAIN NETWORK TYPE PHASE HEIGHT PEERS SYNC ETA
308-
bitcoin-mainnet bitcoin mainnet rpc Syncing 830241 12 73.2% 14h22m
309-
```
310-
311-
Sample manifests for all 102 chains are in [`config/samples/`](config/samples/).
312-
313313
## CRD Reference
314314
315315
### Spec

0 commit comments

Comments
 (0)