This is very much a work in progress, expect things to be rough and potentially break!
pocketci is the first small and trully portable CI engine. This project leverages the Dagger SDK to wrap webhook with ability to automatically clone repositories. It allows you to run dagger commands (and any other kind of commands) in one of two ways:
- Portable CI runner: By starting the service as is you can hook it to a repository through webhooks and run commands in the context of your repo (like doing a
checkouton github actions first!) - Webhook server: By providing a
hooks.jsonon startup you can leverage Dagger modules to hook them into specific webhooks (like a Slack Webhook)
Using webhook allowed us to quickly test the idea of a CI engine that by leveraging Dagger in a native way becomes truly portable. The use of this project means we are limited by the definitions of the hooks.json format which, while being very useful, does not integrate in a native way with Dagger. We want pocketci to integrate seamlessly with Dagger and Dagger modules. You can join the discussion on how to build that here.
- Start the service:
dagger up -m github.com/franela/pocketci serve -p 8080:8080 - Expose it to the internet (you can use the likes of
ngrokto expose local endpoints) - Connect your repository by setting up a webhook in your VCS (github is the only supported at the moment)
- Write a hooks.json file that triggers a dagger command on every commit to the main branch. For example on a github repo:
{
"id": "webhook",
"execute-command": "dagger",
"include-command-output-in-response": true,
"response-headers": [
{
"name": "Access-Control-Allow-Origin",
"value": "*"
}
],
"pass-arguments-to-command": [
{
"source": "string",
"name": "--debug"
},
{
"source": "string",
"name": "--progress=plain"
},
{
"source": "string",
"name": "call"
},
{
"source": "string",
"name": "-m"
},
{
"source": "string",
"name": "github.com/shykes/daggerverse/hello"
},
{
"source": "string",
"name": "message"
}
],
"trigger-rule": {
"and": [
{
"match": {
"type": "value",
"value": "refs/heads/main",
"parameter": {
"source": "payload",
"name": "ref"
}
}
}
]
}
}The working directory of your command will contain the entire contents of your repository at the specified ref so you could run commands from your own dagger module.
By default it proxies requests in a synchronous way, meaning that the execution of your commands will block the incoming requests. This could be a problem if you are exposing this to a provider such as a Github that has a timeout of 10 seconds. To force every request to be processed in an async way, you can pass the flag --proxy-async.
Write a hooks.json. For example one that runs a dagger call on every single request:
{
"id": "webhook",
"execute-command": "dagger",
"include-command-output-in-response": true,
"response-headers": [
{
"name": "Access-Control-Allow-Origin",
"value": "*"
}
],
"pass-arguments-to-command": [
{
"source": "string",
"name": "--debug"
},
{
"source": "string",
"name": "--progress=plain"
},
{
"source": "string",
"name": "call"
},
{
"source": "string",
"name": "-m"
},
{
"source": "string",
"name": "github.com/shykes/daggerverse/hello"
},
{
"source": "string",
"name": "message"
}
]
}Run it with: dagger up -p 8081:8080 -m github.com/franela/pocketci serve --hooks hooks.json. You can validate that your webhook is triggered: curl http://localhost:8080/hooks/webhook. You should see a response such as:
1: load call
1: loading module
1: loading module [6.57s]
1: loading objects
1: loading objects [3.02s]
1: traversing arguments
1: traversing arguments [0.00s]
1: load call DONE
2: dagger call message
DEBUG: executing query="query{hello{message}}"
Hello, World!
2: dagger call message DONE