module-template/

directory
v1.19.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 1, 2024 License: MIT, Apache-2.0

README ΒΆ

Module ModuleTemplate for Dagger

Dagger Version

A simple Dagger place the description of the module here

Configuration πŸ› οΈ

Through the Dagger CLI, or by using it directly within your module, you can configure the following options:

  • βš™οΈ ctr: The container to use as a base container. If not specified, a new container is created.
  • βš™οΈ version: The version of the Go image to use. Defaults to latest.
  • βš™οΈ image: The Go image to use. Defaults to golang:alpine.

Features 🎨

Command or functionality Command Example Status
Run Go Tests run dagger call βœ…

Using the ModuleTemplate Module πŸš€

Place the description of the module here


Usage through the Dagger CLI πŸš€

List all the functions available in the module:

# enter into the module's directory
cd module-template

# list all the functions available in the module
dagger develop && dagger functions

Call a function:

# call a function
# dagger call <function-name> [arguments]
dagger call github.com/excoriate/daggerverse/module-template@version <function-name> [arguments]

Testing πŸ§ͺ

This module includes a testing module that aims to test the functionality of the ModuleTemplate module. The tests are written in Go and can be run using the following command:

## Run the tests using the just command
just test module-template

Developer Experience πŸ› οΈ

If you'd like to contribute, mostly we use Just to automate tasks and Nix to manage the development environment. You can use the following commands to get started:

# initialize the pre-commit hooks
just init
# run CI or common things locally
just golint module-template
# run the tests
just test module-template
# Run the entire CI tasks locally
just cilocal module-template

NOTE: The just command entails the use of the Justfile for task automation.

Directories ΒΆ

Path Synopsis
Package main provides methods for setting up and managing a container environment.
Package main provides methods for setting up and managing a container environment.
tests
dagger command
A generated module for test the ModuleTemplate functions
A generated module for test the ModuleTemplate functions

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL