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 athttp://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/csatib02/openmeter@debd6eae36ef052f5b0e5a050ee10fd8076eefe1
Entrypoint
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
func (m *myModule) example() *Ci {
return dag.
Ci()
}
Types
Ci 🔗
generate() 🔗
Generate various artifacts.
Return Type
Generate !
Example
func (m *myModule) example() *CiGenerate {
return dag.
Ci().
Generate()
}
ci() 🔗
Return Type
Void !
Example
func (m *myModule) example(ctx context.Context) {
return dag.
Ci().
Ci(ctx)
}
test() 🔗
Return Type
Container !
Example
func (m *myModule) 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
func (m *myModule) example(service *Service, port int) *Container {
return dag.
Ci().
QuickstartTest(service, port)
}
lint() 🔗
Return Type
Lint !
Example
func (m *myModule) example() *CiLint {
return dag.
Ci().
Lint()
}
snapshot() 🔗
Return Type
Void !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
stainlessToken | Secret ! | - | No description provided |
Example
func (m *myModule) example(ctx context.Context, stainlessToken *Secret) {
return dag.
Ci().
Snapshot(ctx, stainlessToken)
}
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
func (m *myModule) example(ctx context.Context, version string, githubActor string, githubToken *Secret, pypiToken *Secret, npmToken *Secret) {
return dag.
Ci().
Release(ctx, version, githubActor, githubToken, pypiToken, npmToken)
}
build() 🔗
Build individual artifacts. (Useful for testing and development)
Return Type
Build !
Example
func (m *myModule) example() *CiBuild {
return dag.
Ci().
Build()
}
etoe() 🔗
Return Type
Container !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
test | String | - | No description provided |
Example
func (m *myModule) example() *Container {
return dag.
Ci().
Etoe()
}
Generate 🔗
pythonSdk() 🔗
Generate the Python SDK.
Return Type
Directory !
Example
func (m *myModule) example() *Directory {
return dag.
Ci().
Generate().
PythonSdk()
}
nodeSdk() 🔗
Generate the Node SDK.
Return Type
Directory !
Example
func (m *myModule) example() *Directory {
return dag.
Ci().
Generate().
NodeSdk()
}
webSdk() 🔗
Generate the Web SDK.
Return Type
Directory !
Example
func (m *myModule) example() *Directory {
return dag.
Ci().
Generate().
WebSdk()
}
Lint 🔗
source() 🔗
Return Type
Directory !
Example
func (m *myModule) example() *Directory {
return dag.
Ci().
Lint().
Source()
}
all() 🔗
Return Type
Void !
Example
func (m *myModule) example(ctx context.Context) {
return dag.
Ci().
Lint().
All(ctx)
}
go() 🔗
Return Type
Container !
Example
func (m *myModule) example() *Container {
return dag.
Ci().
Lint().
Go()
}
openapi() 🔗
Return Type
Container !
Example
func (m *myModule) example() *Container {
return dag.
Ci().
Lint().
Openapi()
}
helm() 🔗
Return Type
Void !
Example
func (m *myModule) example(ctx context.Context) {
return dag.
Ci().
Lint().
Helm(ctx)
}
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
func (m *myModule) example(ctx context.Context) {
return dag.
Ci().
Build().
All(ctx)
}
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
func (m *myModule) example() *Container {
return dag.
Ci().
Build().
ContainerImage()
}
binary() 🔗
Build binaries.
Return Type
Binary !
Example
func (m *myModule) 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
func (m *myModule) example(name string) *File {
return dag.
Ci().
Build().
HelmChart(name)
}
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
func (m *myModule) example(ctx context.Context) {
return dag.
Ci().
Build().
Binary().
All(ctx)
}
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
func (m *myModule) 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
func (m *myModule) 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
func (m *myModule) example() *File {
return dag.
Ci().
Build().
Binary().
BenthosCollector()
}