docci integration attempt 1

Author: reecepbcups

.github/workflows/docci.yml

@@ -0,0 +1,62 @@
+name: Docci E2E (docs)
+
+on:
+#   push:
+#     branches:
+#       - main
+  pull_request:
+  workflow_dispatch:
+
+# Ensures that only a single workflow per PR will run at a time. Cancels in-progress jobs if new commit is pushed.
+concurrency:
+    group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+    cancel-in-progress: true
+
+env:
+  GO_VERSION: 1.23.0
+
+jobs:
+  run:
+    runs-on: ubuntu-latest
+    env:
+      DEBUGGING: true
+      RUST_BACKTRACE: 1
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    - name: Install Ubuntu packages
+      run: sudo apt-get update && sudo apt-get install bash make jq
+
+    - uses: actions/setup-node@v4
+      name: Install Node.js
+      with:
+        node-version: 21
+
+    - name: Setup go
+      uses: actions/setup-go@v4
+      with:
+          go-version: ${{ env.GO_VERSION }}
+
+    - name: Install Docci Readme Runner
+      run: |
+        VERSION=v0.9.2-alpha.1
+        wget -O docci.tar.gz "https://github.com/Reecepbcups/docci/releases/download/${VERSION}/docci_Linux_x86_64.tar.gz"
+        tar -xzf docci.tar.gz
+        sudo mv docci /usr/local/bin/docci
+        sudo chmod +x /usr/local/bin/docci
+        rm docci.tar.gz
+
+
+    - name: setup & install spawn
+      run: docci run docs/versioned_docs/version-v0.50.x/01-setup/docci_config.json
+
+    - name: builds chain
+      run: docci run docs/versioned_docs/version-v0.50.x/02-build-your-application/01-nameservice.md
+
+    - name: run application
+      run: |
+        docci run docs/versioned_docs/version-v0.50.x/02-build-your-application/docci_config.json \
+          --hide-background-logs --working-dir rollchain \
+          --cleanup-commands="killall rolld" --cleanup-commands="rm -rf rollchain"

cmd.md

@@ -0,0 +1,15 @@
+
+```bash
+# docci run docs/versioned_docs/version-v0.50.x/01-setup/02-install-spawn.md,docs/versioned_docs/version-v0.50.x/02-build-your-application/01-nameservice.md --hide-background-logs
+
+# TODO: we have to support JSON files to have an array of relative file paths in the area
+
+# generate chain (outside of the rollchain dir since it is not generated yet)
+docci run docs/versioned_docs/version-v0.50.x/02-build-your-application/01-nameservice.md --hide-background-logs
+
+# interaction (02 - 05)
+docci run docs/versioned_docs/version-v0.50.x/02-build-your-application/docci_config.json --hide-background-logs --working-dir rollchain
+
+# cleanup
+rm -rf rollchain
+```

docs/versioned_docs/version-v0.50.x/01-setup/01-system-setup.md

@@ -34,7 +34,7 @@ Install [VSCode](https://code.visualstudio.com/download) if you do not already h
 <Tabs defaultValue="macos">
   <TabItem value="macos" label="MacOS">
 
-  ```bash
+  ```bash docci-os=macos
   # Setup Homebrew (https://brew.sh/)
   /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
   sudo echo 'export PATH=$PATH:/opt/homebrew/bin' >> ~/.zshrc
@@ -104,7 +104,7 @@ Install [VSCode](https://code.visualstudio.com/download) if you do not already h
   <TabItem value="ubuntu-linux" label="Linux (Ubuntu)">
 
   <!-- markdown-link-check-disable -->
-  ```bash
+  ```bash docci-os=linux
   # Base
   sudo apt install make gcc git jq wget
 
@@ -131,7 +131,7 @@ Install [VSCode](https://code.visualstudio.com/download) if you do not already h
   Some tutorials require CosmWasm (Rust smart contracts) setup. This section is option, unless a tutorial is CosmWasm focused.
 
   CosmWasm requires [Rust](https://www.rust-lang.org/). You must have this installed as the contract will be built locally.
-  ```bash
+  ```bash docci-ignore
   # Install rust - https://www.rust-lang.org/tools/install
   curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
 

docs/versioned_docs/version-v0.50.x/01-setup/02-install-spawn.md

@@ -19,10 +19,10 @@ Install Spawn from source.
 
 ```bash
 # Install from latest source
-git clone https://github.com/rollchains/spawn.git --depth 1 --branch v0.50.15
+git clone https://github.com/rollchains/spawn.git --depth 1 --branch v0.50.15 spawn_bin
 
 # Change to this directory
-cd spawn
+cd spawn_bin
 
 # Clear Go modules cache for a fresh install
 go clean -modcache
@@ -42,13 +42,15 @@ spawn
 local-ic
 
 heighliner
+
+rm -rf spawn_bin
 ```
 
 ## Command not found error
 
 If you get "command 'spawn' not found", run:
 
-```bash
+```bash docci-ignore
 # Gets your operating system
 unameOut="$(uname -s)"
 case "${unameOut}" in

docs/versioned_docs/version-v0.50.x/01-setup/docci_config.json

@@ -0,0 +1,6 @@
+{
+    "files": [
+        "01-system-setup.md",
+        "02-install-spawn.md"
+    ]
+}

docs/versioned_docs/version-v0.50.x/02-build-your-application/01-nameservice.md

@@ -44,7 +44,7 @@ Let's create a new chain called 'rollchain'. You are going to set defining chara
 - Binary executable (bin)
 
 ```bash
-spawn new rollchain --consensus=pos --disable=cosmwasm --bech32=roll --denom=uroll --bin=rolld
+spawn new rollchain --consensus=pos --disable=cosmwasm,explorer --bech32=roll --denom=uroll --bin=rolld
 ```
 
 🎉 Your new blockchain 'rollchain' is now generated!

docs/versioned_docs/version-v0.50.x/02-build-your-application/02-proto-logic.md

@@ -13,7 +13,7 @@ Extend the template module and add how to store and interact with data. Specific
 
 Open the `proto/nameservice/v1` directory. Edit `tx.proto` to add the transaction setter message.
 
-```protobuf title="proto/nameservice/v1/tx.proto"
+```protobuf title="proto/nameservice/v1/tx.proto" docci-file="proto/nameservice/v1/tx.proto" docci-line-replace=19
 
   // SetServiceName allows a user to set their accounts name.
   rpc SetServiceName(MsgSetServiceName) returns (MsgSetServiceNameResponse);
@@ -42,7 +42,8 @@ proto/nameservice/v1/tx.proto file
 
 Find `query.proto` and add the following
 
-```protobuf title="proto/nameservice/v1/query.proto"
+<!-- TODO: verify if this should be 15 or 14 (0 or 1 indexed) -->
+```protobuf title="proto/nameservice/v1/query.proto" docci-file="proto/nameservice/v1/query.proto" docci-line-replace=15
 
   // ResolveName allows a user to resolve the name of an account.
   rpc ResolveName(QueryResolveNameRequest) returns (QueryResolveNameResponse) {

docs/versioned_docs/version-v0.50.x/02-build-your-application/03-application-logic.md

@@ -35,13 +35,25 @@ func NewKeeper() Keeper {
 }
 ```
 
+<!-- ==================
+```bash docci-file=x/nameservice/keeper/keeper.go docci-line-replace=29
+	NameMapping collections.Map[string, string]
+```
+
+```bash docci-file=x/nameservice/keeper/keeper.go docci-line-replace=64
+		NameMapping: collections.NewMap(sb, collections.NewPrefix(1),
+			"name_mapping", collections.StringKey, collections.StringValue,
+		),
+```
+================== -->
+
 ---
 
 ## Application Logic
 
 Update the msg_server logic to set the name upon request from a user.
 
-```go title="x/nameservice/keeper/msg_server.go"
+```go title="x/nameservice/keeper/msg_server.go" docci-file=x/nameservice/keeper/msg_server.go docci-line-replace=30-38
 func (ms msgServer) SetServiceName(ctx context.Context, msg *types.MsgSetServiceName) (*types.MsgSetServiceNameResponse, error) {
 	// highlight-start
 	if err := ms.k.NameMapping.Set(ctx, msg.Sender, msg.Name); err != nil {
@@ -55,7 +67,7 @@ func (ms msgServer) SetServiceName(ctx context.Context, msg *types.MsgSetService
 
 and also for the query_server to retrieve the name.
 
-```go title="x/nameservice/keeper/query_server.go"
+```go title="x/nameservice/keeper/query_server.go" docci-file=x/nameservice/keeper/query_server.go docci-line-replace=33-37
 func (k Querier) ResolveName(goCtx context.Context, req *types.QueryResolveNameRequest) (*types.QueryResolveNameResponse, error) {
 	// highlight-start
 	v, err := k.Keeper.NameMapping.Get(goCtx, req.Wallet)

docs/versioned_docs/version-v0.50.x/02-build-your-application/04-cli.md

@@ -13,7 +13,7 @@ Using the AutoCLI, you will easily set up the CLI client for transactions and qu
 
 Update the autocli to allow someone to get the name of a wallet account.
 
-```go title="x/nameservice/autocli.go"
+```go title="x/nameservice/autocli.go" docci-file="x/nameservice/autocli.go" docci-line-replace=11-20
 		Query: &autocliv1.ServiceCommandDescriptor{
             Service: modulev1.Query_ServiceDesc.ServiceName,
 			RpcCommandOptions: []*autocliv1.RpcCommandOptions{
@@ -48,7 +48,7 @@ Update the autocli to allow someone to get the name of a wallet account.
 
 Also add interaction in `x/nameservice/autocli.go` to set the name of a wallet account.
 
-```go title="x/nameservice/autocli.go"
+```go title="x/nameservice/autocli.go"  docci-file="x/nameservice/autocli.go" docci-line-replace=31-39
 		Tx: &autocliv1.ServiceCommandDescriptor{
 			Service: modulev1.Msg_ServiceDesc.ServiceName,
 			RpcCommandOptions: []*autocliv1.RpcCommandOptions{

docs/versioned_docs/version-v0.50.x/02-build-your-application/05-testnet.md

@@ -19,7 +19,7 @@ Congrats!! You built your first network already. You are ready to run a local te
 
 Use the `sh-testnet` command *(short for shell testnet)* to quickly build your application, generate example wallet accounts, and start the local network on your machine.
 
-```bash
+```bash docci-background
 # Run a quick shell testnet
 make sh-testnet
 ```
@@ -32,22 +32,22 @@ Using the newly built binary executable *(rolld from the --bin flag when the cha
 
 You can either query or set data in the network using the command executable. If you wish to perform an action you submit a transaction (tx). If you wish to read data  you are querying (q). The next sub command specifies which module will receive the action on. In this case, the `nameservice` module since our module is named nameservice. Then the `set` command is called, which was defined in the autocli.go.
 
-```bash
-rolld tx nameservice set alice --from=acc1 --yes
+```bash docci-wait-for-endpoint=http://localhost:26657/health|300 docci-delay-per-cmd=2 docci-delay-before=5 docci-output-contains="/nameservice.v1.MsgSetServiceName"
+# set your name
+TX_HASH=`rolld tx nameservice set alice --from=acc1 --yes -o json | jq -r '.txhash'`
 
 # You can verify this transaction was successful
 # By querying it's unique ID.
-rolld q tx EC3FBF3248E24B5FEB6A5F7F35BBB4634E9C75587119E3FBCF5C1FED05E5A399
+rolld q tx $TX_HASH
 ```
 
 ## Interaction Get Name
 
 Now you are going to get the name of a wallet. A nested command `$(rolld keys show acc1 -a)` gets the unique address of the acc1 account added when you started the testnet.
 
-```bash
-rolld q nameservice resolve roll1efd63aw40lxf3n4mhf7dzhjkr453axur57cawh --output=json
-
-rolld q nameservice resolve $(rolld keys show acc1 -a) --output=json
+```bash docci-output-contains=alice
+ADDRESS=$(rolld keys show acc1 -a)
+rolld q nameservice resolve ${ADDRESS} --output=json
 ```
 
 The expected result should be:
@@ -62,5 +62,11 @@ The expected result should be:
 When you are ready to stop the testnet, you can use `ctrl + c` or `killall -9 rolld`.
 :::
 
+<!--
+Kill rolld after use
+```bash
+killall rolld
+```
+ -->
 
 Your network is now running and you have successfully set and resolved a name! 🎉