Skip to content

Latest commit

 

History

History

ci

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
build
build
 
 
consts
consts
 
 
mage
mage
 
 
util
util
 
 
.gitattributes
.gitattributes
 
 
.gitignore
.gitignore
 
 
README.md
README.md
 
 
cli.go
cli.go
 
 
config.go
config.go
 
 
docs.go
docs.go
 
 
engine.go
engine.go
 
 
go.mod
go.mod
 
 
go.sum
go.sum
 
 
helm.go
helm.go
 
 
main.go
main.go
 
 
sdk.go
sdk.go
 
 
sdk_elixir.go
sdk_elixir.go
 
 
sdk_go.go
sdk_go.go
 
 
sdk_java.go
sdk_java.go
 
 
sdk_php.go
sdk_php.go
 
 
sdk_python.go
sdk_python.go
 
 
sdk_rust.go
sdk_rust.go
 
 
sdk_typescript.go
sdk_typescript.go
 
 
test.go
test.go
 
 
version.go
version.go
 
 

README.md

CI

This dagger module is used to define the CI for the dagger project itself, including building and releasing the CLI, engine and SDKs themselves.

Available functionality:

$ dagger functions
Name     Description
cli      -
dev      Creates a dev container that has a running CLI connected to a dagger engine
docs     -
engine   -
sdk      -
test     -

Note

For best results, use the same version of dagger (both the CLI, and the engine) as defined in .github/workflows/_hack_make.yml. Without this, you may hit unexpected errors or other weird behavior.

Developing after a fresh clone

If you want to develop this module following a repository clone, remember to run the following one-off command:

cd ..
dagger develop --sdk go --source ci

This will re-create all the files required by your code editor - see .gitignore for a list of what they are.

Tests

Run all tests:

dagger call --source=.:default test all

Run a specific test (e.g. TestModuleNamespacing):

dagger call --source=.:default test custom --run="^TestModuleNamespacing" --pkg="./core/integration"

Dev environment

Start a little dev shell with dagger-in-dagger:

dagger call --source=.:default dev

Engine & CLI

Linting

Run the engine linter:

dagger call --source=.:default engine lint

Build the CLI

Build the CLI:

dagger call --source=.:default cli file export --path=./dagger

Run the engine service

Run the engine as a service:

dagger call --source=.:default engine service --name=dagger-engine up --ports=1234:1234

Connect to it from a dagger cli:

export _EXPERIMENTAL_DAGGER_RUNNER_HOST=tcp:https://0.0.0.0:1234
dagger call -m github.com/shykes/daggerverse/hello@main hello
# hello, world!

Docs

Lint the docs:

dagger call --source=.:default docs lint

Auto-generate docs components:

dagger call --source=.:default docs generate export --path=.

SDKs

Available SDKs:

dagger functions sdk
# Name         Description
# elixir       -
# go           -
# java         -
# php          -
# python       -
# rust         -
# typescript   -

All SDKs have the same functions defined:

  • lint: lints SDK-specific files
  • test: tests SDK functionality against a dev engine
  • generate: generates any auto-generated files against a dev engine
  • bump: bumps the SDK version number
  • publish: publishes the SDK to a registry
    • Note: options for this function are SDK-specific

Linting

Run an SDK linter (replace <sdk> with one of the supported SDKs):

dagger call --source=.:default sdk <sdk> lint

Tests

Run SDK tests (replace <sdk> with one of the supported SDKs):

dagger call --source=.:default sdk <sdk> test

Generate

Generate SDK static files (replace <sdk> with one of the supported SDKs):

dagger call --source=.:default sdk <sdk> generate export --path=.

Publish

Dry-run an SDK publishing step (replace <sdk> with one of the supported SDKs):

dagger call --source=.:default sdk <sdk> publish --dry-run

Bump

Bump an SDK version for releasing (replace <sdk> with one of the supported SDKs):

dagger call --source=.:default sdk <sdk> bump --version=$VERSION export --path=.