Skip to content

Commit a885386

Browse files
authored
docs: improve operator guide (#641)
1 parent 52627ed commit a885386

File tree

4 files changed

+27
-6
lines changed

4 files changed

+27
-6
lines changed

Makefile

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ OS := $(shell uname -s)
55
CONFIG_FILE?=config-files/config.yaml
66
AGG_CONFIG_FILE?=config-files/config-aggregator.yaml
77

8-
OPERATOR_VERSION=v0.2.1
8+
OPERATOR_VERSION=v0.3.0
99

1010
ifeq ($(OS),Linux)
1111
BUILD_ALL_FFI = $(MAKE) build_all_ffi_linux
@@ -101,6 +101,12 @@ build_operator: deps
101101
@go build -ldflags "-X main.Version=$(OPERATOR_VERSION)" -o ./operator/build/aligned-operator ./operator/cmd/main.go
102102
@echo "Operator built into /operator/build/aligned-operator"
103103

104+
update_operator:
105+
@echo "Updating Operator..."
106+
@./scripts/fetch_latest_release.sh
107+
@make build_operator
108+
@./operator/build/aligned-operator --version
109+
104110
bindings:
105111
cd contracts && ./generate-go-bindings.sh
106112

docs/guides/1_SDK.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ To use this SDK in your Rust project, add the following to your `Cargo.toml`:
1111

1212
```toml
1313
[dependencies]
14-
aligned-sdk = { git = "https://github.com/yetanotherco/aligned_layer", tag="v0.2.1" }
14+
aligned-sdk = { git = "https://github.com/yetanotherco/aligned_layer", tag="v0.3.0" }
1515
```
1616

1717
To find the latest release tag go to [releases](https://github.com/yetanotherco/aligned_layer/releases) and copy the version of the release that has the `latest` badge.

docs/operator_guides/0_running_an_operator.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# Register as an Aligned operator in testnet
22

3+
> **CURRENT VERSION:**
4+
> Aligned Operator [v0.3.0](https://github.com/yetanotherco/aligned_layer/releases/tag/v0.3.0)
5+
36
> **IMPORTANT:**
47
> You must be [whitelisted](https://docs.google.com/forms/d/e/1FAIpQLSdH9sgfTz4v33lAvwj6BvYJGAeIshQia3FXz36PFfF-WQAWEQ/viewform) to become an Aligned operator.
58
@@ -38,7 +41,7 @@ Minimum hardware requirements:
3841
To start with, clone the Aligned repository and move inside it
3942

4043
```bash
41-
git clone https://github.com/yetanotherco/aligned_layer.git
44+
git clone https://github.com/yetanotherco/aligned_layer.git --branch v0.3.0
4245
cd aligned_layer
4346
```
4447

@@ -70,15 +73,20 @@ To build the operator binary, run:
7073
make build_operator
7174
```
7275

73-
To update the operator, run:
76+
### Upgrading the Operator
77+
78+
If you want to upgrade the operator, run:
7479

7580
```bash
76-
git pull
77-
make build_operator
81+
make update_operator
7882
```
7983

8084
This will recreate the binaries. You can then proceed to restart the operator.
8185

86+
You can find the latest version of the operator [here](https://github.com/yetanotherco/aligned_layer/releases).
87+
88+
### Checking the Operator Version
89+
8290
To see the operator version, run:
8391

8492
```bash

scripts/fetch_latest_release.sh

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
#!/bin/bash
2+
3+
# The script fetches the latest release tag from the repository and checks out that tag.
4+
git fetch --tags
5+
latesttag=$(git describe --tags $(git rev-list --tags --max-count=1))
6+
echo checking out ${latesttag}
7+
git checkout ${latesttag}

0 commit comments

Comments
 (0)