ci
This module has been generated via dagger init and serves as a reference tobasic module structure as you get started with Dagger.
Two functions have been pre-created. You can modify, delete, or add to them,
as needed. They demonstrate usage of arguments and return types using simple
echo and grep commands. The functions can be called from the dagger CLI or
from one of the SDKs.
The first line in this comment block is a short description line and the
rest is a long description with more detail on the module's purpose or usage,
if appropriate. All modules should have a short description.
Installation
dagger install github.com/dario-mr/ci-pipelines@3558489b37198d855e0bac62eda5e1784189d6e2Entrypoint
Return Type
Ci ! Example
dagger -m github.com/dario-mr/ci-pipelines@3558489b37198d855e0bac62eda5e1784189d6e2 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 🔗
buildAndPush() 🔗
Return Type
String !Arguments
| Name | Type | Default Value | Description |
|---|---|---|---|
| source | Directory ! | - | A directory. |
| dockerUsername | String ! | - | No description provided |
| dockerPassword | Secret ! | - | A reference to a secret value, which can be handled more safely than the value itself. |
| imageName | String ! | - | No description provided |
| withRedis | Boolean ! | false | No description provided |
| withPostgres | Boolean ! | false | No description provided |
Example
dagger -m github.com/dario-mr/ci-pipelines@3558489b37198d855e0bac62eda5e1784189d6e2 call \
build-and-push --source DIR_PATH --docker-username string --docker-password env:MYSECRET --image-name string --with-redis boolean --with-postgres booleanfunc (m *MyModule) Example(ctx context.Context, source *dagger.Directory, dockerUsername string, dockerPassword *dagger.Secret, imageName string, withRedis bool, withPostgres bool) string {
return dag.
Ci().
BuildAndPush(ctx, source, dockerUsername, dockerPassword, imageName, withRedis, withPostgres)
}@function
async def example(source: dagger.Directory, docker_username: str, docker_password: dagger.Secret, image_name: str, with_redis: bool, with_postgres: bool) -> str:
return await (
dag.ci()
.build_and_push(source, docker_username, docker_password, image_name, with_redis, with_postgres)
)@func()
async example(source: Directory, dockerUsername: string, dockerPassword: Secret, imageName: string, withRedis: boolean, withPostgres: boolean): Promise<string> {
return dag
.ci()
.buildAndPush(source, dockerUsername, dockerPassword, imageName, withRedis, withPostgres)
}coverageMarkdown() 🔗
Return Type
String !Arguments
| Name | Type | Default Value | Description |
|---|---|---|---|
| source | Directory ! | - | A directory. |
| baseSource | Directory | null | No description provided |
| changedFiles | String ! | "" | No description provided |
| withRedis | Boolean ! | false | No description provided |
| withPostgres | Boolean ! | false | No description provided |
Example
dagger -m github.com/dario-mr/ci-pipelines@3558489b37198d855e0bac62eda5e1784189d6e2 call \
coverage-markdown --source DIR_PATH --changed-files string --with-redis boolean --with-postgres booleanfunc (m *MyModule) Example(ctx context.Context, source *dagger.Directory, changedFiles string, withRedis bool, withPostgres bool) string {
return dag.
Ci().
CoverageMarkdown(ctx, source, changedFiles, withRedis, withPostgres)
}@function
async def example(source: dagger.Directory, changed_files: str, with_redis: bool, with_postgres: bool) -> str:
return await (
dag.ci()
.coverage_markdown(source, changed_files, with_redis, with_postgres)
)@func()
async example(source: Directory, changedFiles: string, withRedis: boolean, withPostgres: boolean): Promise<string> {
return dag
.ci()
.coverageMarkdown(source, changedFiles, withRedis, withPostgres)
}test() 🔗
Return Type
String !Arguments
| Name | Type | Default Value | Description |
|---|---|---|---|
| source | Directory ! | - | A directory. |
| withRedis | Boolean ! | false | No description provided |
| withPostgres | Boolean ! | false | No description provided |
Example
dagger -m github.com/dario-mr/ci-pipelines@3558489b37198d855e0bac62eda5e1784189d6e2 call \
test --source DIR_PATH --with-redis boolean --with-postgres booleanfunc (m *MyModule) Example(ctx context.Context, source *dagger.Directory, withRedis bool, withPostgres bool) string {
return dag.
Ci().
Test(ctx, source, withRedis, withPostgres)
}@function
async def example(source: dagger.Directory, with_redis: bool, with_postgres: bool) -> str:
return await (
dag.ci()
.test(source, with_redis, with_postgres)
)@func()
async example(source: Directory, withRedis: boolean, withPostgres: boolean): Promise<string> {
return dag
.ci()
.test(source, withRedis, withPostgres)
}