Skip to content

build(release): expose and verify protocol v4 #79

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nicodes merged 1 commit into from
Aug 28, 2026
Merged

build(release): expose and verify protocol v4 #79

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .github/actions/build/action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,3 +106,10 @@ runs:
echo "::error::built binary reported no version at all"
exit 1
fi

protocol="$($tmp/ormos --protocol-version)"
echo "protocol $protocol"
if [ "$protocol" != "4" ]; then
echo "::error::built binary advertises protocol '$protocol', expected the v4 release contract"
exit 1
fi
3 changes: 3 additions & 0 deletions .github/workflows/release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,9 @@ jobs:
cat > dist/notes.md <<NOTES
ormos $TAG

Advertised tunnel protocol: v4 (with backend compatibility for
released v0-v3 agents during the documented migration window).

\`\`\`sh
go install github.com/nicodes/ormos@$TAG
\`\`\`
Expand Down
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -218,6 +218,7 @@ compatibility window; adding v4 does not itself change those versions' behavior.
go test -race ./...
go vet ./...
go run . --version
go run . --protocol-version
```

The repository is intentionally limited to the public agent and shared
Expand Down
9 changes: 8 additions & 1 deletion internal/system/run.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,10 +50,13 @@ import (
"os"
"os/signal"
"syscall"

"github.com/nicodes/ormos/relay"
)

// Main accepts `ormos`, `ormos --config PATH`, `ormos --help` and
// `ormos --version`, and nothing else — no `-h` shorthand, no subcommands.
// `ormos --version`, `ormos --protocol-version`, and nothing else — no `-h`
// shorthand, no subcommands.
// Parsed by hand rather than with the flag package, which would accept
// single-dash spellings and add its own -h.
//
Expand All @@ -69,6 +72,9 @@ func Main(args []string, version string) {
case len(args) == 1 && args[0] == "--version":
fmt.Println(version)
return
case len(args) == 1 && args[0] == "--protocol-version":
fmt.Println(relay.StreamFenceVersion)
return
case len(args) == 2 && args[0] == "--config" && args[1] != "":
configFileOverride = args[1]
case args[0] == "--config":
Expand All @@ -90,6 +96,7 @@ usage:
ormos --config PATH run with a different config file
ormos --help show this
ormos --version print the version
ormos --protocol-version print the advertised tunnel protocol version

Just run ormos. If this machine isn't registered yet (or its credentials were
revoked by forgetting it in the UI), it shows a short pairing code — approve it
Expand Down