Compare commits
4 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| fae83e8d2f | |||
| 663a52eded | |||
| b093af7905 | |||
| 02070eddb5 |
@@ -15,6 +15,7 @@ jobs:
|
|||||||
- uses: actions/setup-go@v5
|
- uses: actions/setup-go@v5
|
||||||
with:
|
with:
|
||||||
go-version: '1.21'
|
go-version: '1.21'
|
||||||
|
cache: false
|
||||||
|
|
||||||
- name: Build
|
- name: Build
|
||||||
run: go build ./...
|
run: go build ./...
|
||||||
|
|||||||
@@ -14,6 +14,7 @@ jobs:
|
|||||||
- uses: actions/setup-go@v5
|
- uses: actions/setup-go@v5
|
||||||
with:
|
with:
|
||||||
go-version: '1.21'
|
go-version: '1.21'
|
||||||
|
cache: false
|
||||||
|
|
||||||
- name: Build
|
- name: Build
|
||||||
run: go build ./...
|
run: go build ./...
|
||||||
|
|||||||
80
README.md
80
README.md
@@ -1,2 +1,80 @@
|
|||||||
# proto-go
|
# GitCaddy Actions Proto
|
||||||
|
|
||||||
|
Protocol buffer definitions for communication between Gitea Actions runners and the Gitea server.
|
||||||
|
|
||||||
|
> **This is a GitCaddy fork** of [code.gitea.io/actions-proto-go](https://gitea.com/gitea/actions-proto-go) with enhanced capability reporting support.
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
This package provides the protobuf-generated Go code for the Gitea Actions runner protocol. It defines the RPC services and message types used for:
|
||||||
|
|
||||||
|
- Runner registration and declaration
|
||||||
|
- Task fetching and execution
|
||||||
|
- Log streaming and status updates
|
||||||
|
- **Runner capability reporting** (GitCaddy enhancement)
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
```bash
|
||||||
|
go get git.marketally.com/gitcaddy/actions-proto-go
|
||||||
|
```
|
||||||
|
|
||||||
|
## GitCaddy Enhancements
|
||||||
|
|
||||||
|
### Runner Capability Reporting
|
||||||
|
|
||||||
|
This fork adds the `CapabilitiesJson` field to the `DeclareRequest` message, enabling runners to report their capabilities to the Gitea server:
|
||||||
|
|
||||||
|
```protobuf
|
||||||
|
message DeclareRequest {
|
||||||
|
string version = 1;
|
||||||
|
repeated string labels = 2;
|
||||||
|
string capabilities_json = 3; // NEW: JSON-encoded runner capabilities
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
The capabilities JSON includes:
|
||||||
|
- **OS and Architecture**: Runtime environment details
|
||||||
|
- **Docker Support**: Whether Docker/Podman is available
|
||||||
|
- **Shell Support**: Available shells (bash, sh, powershell, etc.)
|
||||||
|
- **Tool Versions**: Installed tools like Node.js, Go, Python, etc.
|
||||||
|
- **Feature Flags**: Cache support, artifact handling, etc.
|
||||||
|
- **Limitations**: Known constraints for AI workflow generation
|
||||||
|
|
||||||
|
### Why This Matters
|
||||||
|
|
||||||
|
AI tools generating CI/CD workflows can query the Gitea API to discover runner capabilities *before* writing workflows, reducing trial-and-error iterations.
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
runnerv1 "git.marketally.com/gitcaddy/actions-proto-go/runner/v1"
|
||||||
|
"git.marketally.com/gitcaddy/actions-proto-go/runner/v1/runnerv1connect"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Create a client
|
||||||
|
client := runnerv1connect.NewRunnerServiceClient(httpClient, serverURL)
|
||||||
|
|
||||||
|
// Declare runner with capabilities
|
||||||
|
resp, err := client.Declare(ctx, connect.NewRequest(&runnerv1.DeclareRequest{
|
||||||
|
Version: "0.3.1",
|
||||||
|
Labels: []string{"ubuntu-latest", "docker"},
|
||||||
|
CapabilitiesJson: `{"os":"linux","arch":"amd64","docker":true}`,
|
||||||
|
}))
|
||||||
|
```
|
||||||
|
|
||||||
|
## Related Projects
|
||||||
|
|
||||||
|
| Project | Description |
|
||||||
|
|---------|-------------|
|
||||||
|
| [gitcaddy/gitea](https://git.marketally.com/gitcaddy/gitea) | GitCaddy Gitea fork with AI-friendly enhancements |
|
||||||
|
| [gitcaddy/act_runner](https://git.marketally.com/gitcaddy/act_runner) | Runner with capability detection |
|
||||||
|
|
||||||
|
## Upstream
|
||||||
|
|
||||||
|
This project is a fork of [code.gitea.io/actions-proto-go](https://gitea.com/gitea/actions-proto-go). We aim to contribute enhancements back to upstream where appropriate.
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
MIT License - see [LICENSE](LICENSE) for details.
|
||||||
|
|||||||
2
go.mod
2
go.mod
@@ -1,4 +1,4 @@
|
|||||||
module git.marketally.com/gitcaddy/actions-proto-go
|
module code.gitea.io/actions-proto-go
|
||||||
|
|
||||||
go 1.19
|
go 1.19
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@
|
|||||||
package pingv1connect
|
package pingv1connect
|
||||||
|
|
||||||
import (
|
import (
|
||||||
v1 "git.marketally.com/gitcaddy/actions-proto-go/ping/v1"
|
v1 "code.gitea.io/actions-proto-go/ping/v1"
|
||||||
connect "connectrpc.com/connect"
|
connect "connectrpc.com/connect"
|
||||||
context "context"
|
context "context"
|
||||||
errors "errors"
|
errors "errors"
|
||||||
|
|||||||
@@ -392,7 +392,8 @@ type FetchTaskRequest struct {
|
|||||||
sizeCache protoimpl.SizeCache
|
sizeCache protoimpl.SizeCache
|
||||||
unknownFields protoimpl.UnknownFields
|
unknownFields protoimpl.UnknownFields
|
||||||
|
|
||||||
TasksVersion int64 `protobuf:"varint,1,opt,name=tasks_version,json=tasksVersion,proto3" json:"tasks_version,omitempty"` // Runner use `tasks_version` to compare with Gitea and detemine whether new tasks may exist.
|
TasksVersion int64 `protobuf:"varint,1,opt,name=tasks_version,json=tasksVersion,proto3" json:"tasks_version,omitempty"` // Runner use `tasks_version` to compare with Gitea and detemine whether new tasks may exist.
|
||||||
|
CapabilitiesJson string `protobuf:"bytes,2,opt,name=capabilities_json,json=capabilitiesJson,proto3" json:"capabilities_json,omitempty"` // JSON-encoded runner capabilities including disk space
|
||||||
}
|
}
|
||||||
|
|
||||||
func (x *FetchTaskRequest) Reset() {
|
func (x *FetchTaskRequest) Reset() {
|
||||||
@@ -434,6 +435,13 @@ func (x *FetchTaskRequest) GetTasksVersion() int64 {
|
|||||||
return 0
|
return 0
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func (x *FetchTaskRequest) GetCapabilitiesJson() string {
|
||||||
|
if x != nil {
|
||||||
|
return x.CapabilitiesJson
|
||||||
|
}
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
|
||||||
type FetchTaskResponse struct {
|
type FetchTaskResponse struct {
|
||||||
state protoimpl.MessageState
|
state protoimpl.MessageState
|
||||||
sizeCache protoimpl.SizeCache
|
sizeCache protoimpl.SizeCache
|
||||||
|
|||||||
@@ -5,7 +5,7 @@
|
|||||||
package runnerv1connect
|
package runnerv1connect
|
||||||
|
|
||||||
import (
|
import (
|
||||||
v1 "git.marketally.com/gitcaddy/actions-proto-go/runner/v1"
|
v1 "code.gitea.io/actions-proto-go/runner/v1"
|
||||||
connect "connectrpc.com/connect"
|
connect "connectrpc.com/connect"
|
||||||
context "context"
|
context "context"
|
||||||
errors "errors"
|
errors "errors"
|
||||||
|
|||||||
Reference in New Issue
Block a user