ci
Licensed under the Apache License, Version 2.0 (the "License");you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Installation
dagger install github.com/openmeterio/openmeter@05b3e2d5deab3bb0b98a7c47bdf4f0fb90ebb214Entrypoint
Return Type
Ci !Arguments
| Name | Type | Default Value | Description |
|---|---|---|---|
| source | Directory | - | Project source directory. |
| ref | String | - | Checkout the repository (at the designated ref) and use it as the source directory instead of the local one. |
Example
dagger -m github.com/openmeterio/openmeter@05b3e2d5deab3bb0b98a7c47bdf4f0fb90ebb214 call \
func (m *MyModule) Example() *dagger.Ci {
return dag.
Ci()
}@function
def example() -> dagger.Ci:
return (
dag.ci()
)@func()
example(): Ci {
return dag
.ci()
}Types
Ci 🔗
generate() 🔗
Generate various artifacts.
Return Type
Generate ! Example
dagger -m github.com/openmeterio/openmeter@05b3e2d5deab3bb0b98a7c47bdf4f0fb90ebb214 call \
generatefunc (m *MyModule) Example() *dagger.CiGenerate {
return dag.
Ci().
Generate()
}@function
def example() -> dagger.CiGenerate:
return (
dag.ci()
.generate()
)@func()
example(): CiGenerate {
return dag
.ci()
.generate()
}ci() 🔗
Return Type
Void ! Example
dagger -m github.com/openmeterio/openmeter@05b3e2d5deab3bb0b98a7c47bdf4f0fb90ebb214 call \
cifunc (m *MyModule) Example(ctx context.Context) {
return dag.
Ci().
Ci(ctx)
}@function
async def example() -> None:
return await (
dag.ci()
.ci()
)@func()
async example(): Promise<void> {
return dag
.ci()
.ci()
}test() 🔗
Return Type
Container ! Example
dagger -m github.com/openmeterio/openmeter@05b3e2d5deab3bb0b98a7c47bdf4f0fb90ebb214 call \
testfunc (m *MyModule) Example() *dagger.Container {
return dag.
Ci().
Test()
}@function
def example() -> dagger.Container:
return (
dag.ci()
.test()
)@func()
example(): Container {
return dag
.ci()
.test()
}quickstartTest() 🔗
Return Type
Container !Arguments
| Name | Type | Default Value | Description |
|---|---|---|---|
| service | Service ! | - | No description provided |
| port | Integer ! | 8888 | No description provided |
Example
dagger -m github.com/openmeterio/openmeter@05b3e2d5deab3bb0b98a7c47bdf4f0fb90ebb214 call \
quickstart-test --service PROTOCOL://HOST:PORT --port integerfunc (m *MyModule) Example(service *dagger.Service, port int) *dagger.Container {
return dag.
Ci().
QuickstartTest(service, port)
}@function
def example(service: dagger.Service, port: int) -> dagger.Container:
return (
dag.ci()
.quickstart_test(service, port)
)@func()
example(service: Service, port: number): Container {
return dag
.ci()
.quickstartTest(service, port)
}build() 🔗
Build individual artifacts. (Useful for testing and development)
Return Type
Build ! Example
dagger -m github.com/openmeterio/openmeter@05b3e2d5deab3bb0b98a7c47bdf4f0fb90ebb214 call \
buildfunc (m *MyModule) Example() *dagger.CiBuild {
return dag.
Ci().
Build()
}@function
def example() -> dagger.CiBuild:
return (
dag.ci()
.build()
)@func()
example(): CiBuild {
return dag
.ci()
.build()
}release() 🔗
Return Type
Void !Arguments
| Name | Type | Default Value | Description |
|---|---|---|---|
| version | String ! | - | No description provided |
| githubActor | String ! | - | No description provided |
| githubToken | Secret ! | - | No description provided |
| pypiToken | Secret ! | - | No description provided |
| npmToken | Secret ! | - | No description provided |
Example
dagger -m github.com/openmeterio/openmeter@05b3e2d5deab3bb0b98a7c47bdf4f0fb90ebb214 call \
release --version string --github-actor string --github-token env:MYSECRET --pypi-token env:MYSECRET --npm-token env:MYSECRETfunc (m *MyModule) Example(ctx context.Context, version string, githubActor string, githubToken *dagger.Secret, pypiToken *dagger.Secret, npmToken *dagger.Secret) {
return dag.
Ci().
Release(ctx, version, githubActor, githubToken, pypiToken, npmToken)
}@function
async def example(version: str, github_actor: str, github_token: dagger.Secret, pypi_token: dagger.Secret, npm_token: dagger.Secret) -> None:
return await (
dag.ci()
.release(version, github_actor, github_token, pypi_token, npm_token)
)@func()
async example(version: string, githubActor: string, githubToken: Secret, pypiToken: Secret, npmToken: Secret): Promise<void> {
return dag
.ci()
.release(version, githubActor, githubToken, pypiToken, npmToken)
}etoe() 🔗
Return Type
Container !Arguments
| Name | Type | Default Value | Description |
|---|---|---|---|
| test | String | - | No description provided |
Example
dagger -m github.com/openmeterio/openmeter@05b3e2d5deab3bb0b98a7c47bdf4f0fb90ebb214 call \
etoefunc (m *MyModule) Example() *dagger.Container {
return dag.
Ci().
Etoe()
}@function
def example() -> dagger.Container:
return (
dag.ci()
.etoe()
)@func()
example(): Container {
return dag
.ci()
.etoe()
}lint() 🔗
Return Type
Lint ! Example
dagger -m github.com/openmeterio/openmeter@05b3e2d5deab3bb0b98a7c47bdf4f0fb90ebb214 call \
lintfunc (m *MyModule) Example() *dagger.CiLint {
return dag.
Ci().
Lint()
}@function
def example() -> dagger.CiLint:
return (
dag.ci()
.lint()
)@func()
example(): CiLint {
return dag
.ci()
.lint()
}snapshot() 🔗
Return Type
Void !Arguments
| Name | Type | Default Value | Description |
|---|---|---|---|
| stainlessToken | Secret ! | - | No description provided |
Example
dagger -m github.com/openmeterio/openmeter@05b3e2d5deab3bb0b98a7c47bdf4f0fb90ebb214 call \
snapshot --stainless-token env:MYSECRETfunc (m *MyModule) Example(ctx context.Context, stainlessToken *dagger.Secret) {
return dag.
Ci().
Snapshot(ctx, stainlessToken)
}@function
async def example(stainless_token: dagger.Secret) -> None:
return await (
dag.ci()
.snapshot(stainless_token)
)@func()
async example(stainlessToken: Secret): Promise<void> {
return dag
.ci()
.snapshot(stainlessToken)
}Generate 🔗
pythonSdk() 🔗
Generate the Python SDK.
Return Type
Directory ! Example
dagger -m github.com/openmeterio/openmeter@05b3e2d5deab3bb0b98a7c47bdf4f0fb90ebb214 call \
generate \
python-sdkfunc (m *MyModule) Example() *dagger.Directory {
return dag.
Ci().
Generate().
PythonSdk()
}@function
def example() -> dagger.Directory:
return (
dag.ci()
.generate()
.python_sdk()
)@func()
example(): Directory {
return dag
.ci()
.generate()
.pythonSdk()
}nodeSdk() 🔗
Generate the Node SDK.
Return Type
Directory ! Example
dagger -m github.com/openmeterio/openmeter@05b3e2d5deab3bb0b98a7c47bdf4f0fb90ebb214 call \
generate \
node-sdkfunc (m *MyModule) Example() *dagger.Directory {
return dag.
Ci().
Generate().
NodeSdk()
}@function
def example() -> dagger.Directory:
return (
dag.ci()
.generate()
.node_sdk()
)@func()
example(): Directory {
return dag
.ci()
.generate()
.nodeSdk()
}webSdk() 🔗
Generate the Web SDK.
Return Type
Directory ! Example
dagger -m github.com/openmeterio/openmeter@05b3e2d5deab3bb0b98a7c47bdf4f0fb90ebb214 call \
generate \
web-sdkfunc (m *MyModule) Example() *dagger.Directory {
return dag.
Ci().
Generate().
WebSdk()
}@function
def example() -> dagger.Directory:
return (
dag.ci()
.generate()
.web_sdk()
)@func()
example(): Directory {
return dag
.ci()
.generate()
.webSdk()
}Build 🔗
all() 🔗
Return Type
Void !Arguments
| Name | Type | Default Value | Description |
|---|---|---|---|
| platform | Scalar | - | Target platform in "[os]/[platform]/[version]" format (e.g., "darwin/arm64/v7", "windows/amd64", "linux/arm64"). |
Example
dagger -m github.com/openmeterio/openmeter@05b3e2d5deab3bb0b98a7c47bdf4f0fb90ebb214 call \
build \
allfunc (m *MyModule) Example(ctx context.Context) {
return dag.
Ci().
Build().
All(ctx)
}@function
async def example() -> None:
return await (
dag.ci()
.build()
.all()
)@func()
async example(): Promise<void> {
return dag
.ci()
.build()
.all()
}containerImage() 🔗
Build a container image.
Return Type
Container !Arguments
| Name | Type | Default Value | Description |
|---|---|---|---|
| platform | Scalar | - | Target platform in "[os]/[platform]/[version]" format (e.g., "darwin/arm64/v7", "windows/amd64", "linux/arm64"). |
Example
dagger -m github.com/openmeterio/openmeter@05b3e2d5deab3bb0b98a7c47bdf4f0fb90ebb214 call \
build \
container-imagefunc (m *MyModule) Example() *dagger.Container {
return dag.
Ci().
Build().
ContainerImage()
}@function
def example() -> dagger.Container:
return (
dag.ci()
.build()
.container_image()
)@func()
example(): Container {
return dag
.ci()
.build()
.containerImage()
}binary() 🔗
Build binaries.
Return Type
Binary ! Example
dagger -m github.com/openmeterio/openmeter@05b3e2d5deab3bb0b98a7c47bdf4f0fb90ebb214 call \
build \
binaryfunc (m *MyModule) Example() *dagger.CiBinary {
return dag.
Ci().
Build().
Binary()
}@function
def example() -> dagger.CiBinary:
return (
dag.ci()
.build()
.binary()
)@func()
example(): CiBinary {
return dag
.ci()
.build()
.binary()
}helmChart() 🔗
Return Type
File !Arguments
| Name | Type | Default Value | Description |
|---|---|---|---|
| name | String ! | - | Name of the chart to build. |
| version | String | - | Release version. |
Example
dagger -m github.com/openmeterio/openmeter@05b3e2d5deab3bb0b98a7c47bdf4f0fb90ebb214 call \
build \
helm-chart --name stringfunc (m *MyModule) Example(name string) *dagger.File {
return dag.
Ci().
Build().
HelmChart(name)
}@function
def example(name: str) -> dagger.File:
return (
dag.ci()
.build()
.helm_chart(name)
)@func()
example(name: string): File {
return dag
.ci()
.build()
.helmChart(name)
}Lint 🔗
source() 🔗
Return Type
Directory ! Example
dagger -m github.com/openmeterio/openmeter@05b3e2d5deab3bb0b98a7c47bdf4f0fb90ebb214 call \
lint \
sourcefunc (m *MyModule) Example() *dagger.Directory {
return dag.
Ci().
Lint().
Source()
}@function
def example() -> dagger.Directory:
return (
dag.ci()
.lint()
.source()
)@func()
example(): Directory {
return dag
.ci()
.lint()
.source()
}all() 🔗
Return Type
Void ! Example
dagger -m github.com/openmeterio/openmeter@05b3e2d5deab3bb0b98a7c47bdf4f0fb90ebb214 call \
lint \
allfunc (m *MyModule) Example(ctx context.Context) {
return dag.
Ci().
Lint().
All(ctx)
}@function
async def example() -> None:
return await (
dag.ci()
.lint()
.all()
)@func()
async example(): Promise<void> {
return dag
.ci()
.lint()
.all()
}go() 🔗
Return Type
Container ! Example
dagger -m github.com/openmeterio/openmeter@05b3e2d5deab3bb0b98a7c47bdf4f0fb90ebb214 call \
lint \
gofunc (m *MyModule) Example() *dagger.Container {
return dag.
Ci().
Lint().
Go()
}@function
def example() -> dagger.Container:
return (
dag.ci()
.lint()
.go()
)@func()
example(): Container {
return dag
.ci()
.lint()
.go()
}openapi() 🔗
Return Type
Container ! Example
dagger -m github.com/openmeterio/openmeter@05b3e2d5deab3bb0b98a7c47bdf4f0fb90ebb214 call \
lint \
openapifunc (m *MyModule) Example() *dagger.Container {
return dag.
Ci().
Lint().
Openapi()
}@function
def example() -> dagger.Container:
return (
dag.ci()
.lint()
.openapi()
)@func()
example(): Container {
return dag
.ci()
.lint()
.openapi()
}helm() 🔗
Return Type
Void ! Example
dagger -m github.com/openmeterio/openmeter@05b3e2d5deab3bb0b98a7c47bdf4f0fb90ebb214 call \
lint \
helmfunc (m *MyModule) Example(ctx context.Context) {
return dag.
Ci().
Lint().
Helm(ctx)
}@function
async def example() -> None:
return await (
dag.ci()
.lint()
.helm()
)@func()
async example(): Promise<void> {
return dag
.ci()
.lint()
.helm()
}Binary 🔗
all() 🔗
Build all binaries.
Return Type
Void !Arguments
| Name | Type | Default Value | Description |
|---|---|---|---|
| platform | Scalar | - | Target platform in "[os]/[platform]/[version]" format (e.g., "darwin/arm64/v7", "windows/amd64", "linux/arm64"). |
Example
dagger -m github.com/openmeterio/openmeter@05b3e2d5deab3bb0b98a7c47bdf4f0fb90ebb214 call \
build \
binary \
allfunc (m *MyModule) Example(ctx context.Context) {
return dag.
Ci().
Build().
Binary().
All(ctx)
}@function
async def example() -> None:
return await (
dag.ci()
.build()
.binary()
.all()
)@func()
async example(): Promise<void> {
return dag
.ci()
.build()
.binary()
.all()
}api() 🔗
Build the API server binary.
Return Type
File !Arguments
| Name | Type | Default Value | Description |
|---|---|---|---|
| platform | Scalar | - | Target platform in "[os]/[platform]/[version]" format (e.g., "darwin/arm64/v7", "windows/amd64", "linux/arm64"). |
Example
dagger -m github.com/openmeterio/openmeter@05b3e2d5deab3bb0b98a7c47bdf4f0fb90ebb214 call \
build \
binary \
apifunc (m *MyModule) Example() *dagger.File {
return dag.
Ci().
Build().
Binary().
Api()
}@function
def example() -> dagger.File:
return (
dag.ci()
.build()
.binary()
.api()
)@func()
example(): File {
return dag
.ci()
.build()
.binary()
.api()
}sinkWorker() 🔗
Build the sink worker binary.
Return Type
File !Arguments
| Name | Type | Default Value | Description |
|---|---|---|---|
| platform | Scalar | - | Target platform in "[os]/[platform]/[version]" format (e.g., "darwin/arm64/v7", "windows/amd64", "linux/arm64"). |
Example
dagger -m github.com/openmeterio/openmeter@05b3e2d5deab3bb0b98a7c47bdf4f0fb90ebb214 call \
build \
binary \
sink-workerfunc (m *MyModule) Example() *dagger.File {
return dag.
Ci().
Build().
Binary().
SinkWorker()
}@function
def example() -> dagger.File:
return (
dag.ci()
.build()
.binary()
.sink_worker()
)@func()
example(): File {
return dag
.ci()
.build()
.binary()
.sinkWorker()
}benthosCollector() 🔗
Build the sink worker binary.
Return Type
File !Arguments
| Name | Type | Default Value | Description |
|---|---|---|---|
| platform | Scalar | - | Target platform in "[os]/[platform]/[version]" format (e.g., "darwin/arm64/v7", "windows/amd64", "linux/arm64"). |
Example
dagger -m github.com/openmeterio/openmeter@05b3e2d5deab3bb0b98a7c47bdf4f0fb90ebb214 call \
build \
binary \
benthos-collectorfunc (m *MyModule) Example() *dagger.File {
return dag.
Ci().
Build().
Binary().
BenthosCollector()
}@function
def example() -> dagger.File:
return (
dag.ci()
.build()
.binary()
.benthos_collector()
)@func()
example(): File {
return dag
.ci()
.build()
.binary()
.benthosCollector()
}