Skip to content

Commit 5a99b12

Browse files
authored
docs: operations doc improvements (#1714)
* docs: release ethportal-api using verification Frankly, I don't know what changed since --no-verify was required. It works without the flag now, so we should definitely not use it. Verification seems good. * docs: organize and clarify Flamingo sections Separate the instructions about what you need to do once, and the first time you are Flamingo, belong somewhat separate from the other weekly items. * docs: note how to log into hosted glados instances * docs: bump trin version at same time as ethportal-api Also, convert paragraph to numbered steps to follow along more easily.
1 parent 87ed9a3 commit 5a99b12

File tree

3 files changed

+16
-16
lines changed

3 files changed

+16
-16
lines changed

book/src/developers/contributing/releases/deployment.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,7 @@ This step directs Ansible to use the current master version of trin. Read [about
7979
- regular nodes: all remaining ips
8080
- `ssh ubuntu@$IP_ADDR`
8181
- check logs, ignoring DEBUG: `sudo docker logs trin -n 1000 | grep -v DEBUG`
82+
- for glados logins, use `ssh devops@$IP_ADDR` instead
8283
- Check monitoring tools to see if network health is the same or better as before deployment. Glados might lag for 10-15 minutes, so keep checking back.
8384
8485
### Communicate

book/src/developers/contributing/releases/release_checklist.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -21,20 +21,19 @@ group discussion and decision.
2121

2222
## Release dependencies
2323

24-
For now, that's just ethportal-api. Manually bump the version in the
25-
Cargo.toml, and run `cargo update` to update the workspace lockfile. Commit and
26-
merge these changes to trin. Then run:
24+
For now, that's just ethportal-api, plus the whole workspace. Steps to release:
25+
26+
1. Bump the version in that crate's Cargo.toml (pay attention to whether there are any API changes that require a major version bump)
27+
2. Bump the version in the workspace Cargo.toml
28+
3. Run `cargo update` to update the workspace lockfile
29+
4. Get a review on whether the version number changes are appropriate
30+
5. Merge the combined PR into master
31+
6. Publish the ethportal-api release with:
2732

2833
```bash
29-
cd ethportal-api
30-
cargo publish --no-verify
34+
cargo publish -p ethportal-api
3135
```
3236

33-
We would like to get rid of the no-verify ASAP, but for now Cargo.lock is
34-
causing issues that we have no other workaround for. `cargo publish` generates
35-
a new lock file, and then complains that the lockfile is new. See this
36-
[StackOverflow post](https://stackoverflow.com/questions/79276315/how-to-build-a-cargo-lock-file-for-a-package-within-a-workspace).
37-
3837
## Release Trin
3938

4039
We use automated github release workflow to create a new release.

book/src/developers/contributing/rotation/index.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,15 @@ There are some daily tasks, and some transition tasks: Kickoff on Monday & Hando
2121

2222
Unlike your code-heavy weeks, this can be an interruption-heavy week. Although it's often good practice to not get distracted by inbound messages while coding, this week is the opposite: as soon as you see new messages (like on Discord), jump into it.
2323

24-
### Kickoff
24+
### First time ever as Flamingo
2525

26-
Have a discussion with the previous Flamingo on any ongoing issues or in-progress tasks. This is crucial to get a quick understanding of the state of the network and any in-progress tasks to resume.
26+
Read through the "Setup" section of the [Deployment Instructions](../releases/deployment.md) and follow the steps to make sure that your PGP and SSH keys are in place and ready for a deployment.
2727

28-
Make sure your status is "online" in Discord. Make sure you're tagged under the `trin-flamingo` role (ping discord Admin). Put on your favorite pink shirt. Watch a [silly flamingo video](https://www.youtube.com/watch?v=gWNWtbPEWw0). Fly.
28+
### Kickoff: first day of Flamingo week
2929

30-
### First
30+
Have a discussion with the previous Flamingo on any ongoing issues or in-progress tasks. This is crucial to get a quick understanding of the state of the network and any in-progress tasks to resume.
3131

32-
Read through the "Setup" section of the [Deployment Instructions](../releases/deployment.md) and follow the steps to make sure that your PGP and SSH keys are in place and ready for a deployment.
32+
Make sure your status is "online" in Discord. Make sure you're tagged under the `trin-flamingo` role (ping discord Admin). Put on your favorite pink shirt. Watch a [silly flamingo video](https://www.youtube.com/watch?v=gWNWtbPEWw0). Fly.
3333

3434
### Daily
3535

@@ -90,7 +90,7 @@ When you get to the end of your checklist, here are ideas for what to work on ne
9090
- Add new integration tools (eg~ portal-hive -> Discord bot?)
9191
- Scratch your own itch! What do you wish was easier? Now is the time to build it.
9292

93-
### Handoff
93+
### Handoff: last day of Flamingo week
9494

9595
Look back at your week as Flamingo and summarize it in notes if needed. Prepare for a kickoff discussion with the next Flamingo and update them on your work from previous week.
9696

0 commit comments

Comments
 (0)