Skip to content

docs(examples): add tutorial-style Dalec examples (inline, config+systemd, patching, kitchen-sink)#911

Merged
cpuguy83 merged 1 commit intoproject-dalec:mainfrom
kartikjoshi21:kartikjoshi21/learning-examples
Jan 7, 2026
Merged

docs(examples): add tutorial-style Dalec examples (inline, config+systemd, patching, kitchen-sink)#911
cpuguy83 merged 1 commit intoproject-dalec:mainfrom
kartikjoshi21:kartikjoshi21/learning-examples

Conversation

@kartikjoshi21
Copy link
Member

This PR adds several tutorial-style example specs under docs/examples/ to help new users understand how Dalec specs map to packages + images.

Fixes: #828

Copilot AI review requested due to automatic review settings January 5, 2026 15:11
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds four comprehensive tutorial-style example specifications to help new Dalec users understand how to create package and container build definitions. The examples progress from simple to complex, demonstrating key Dalec features with extensive inline documentation.

  • Adds minimal inline source example (hello.inline.yml)
  • Adds daemon packaging example with config and systemd (config-and-systemd.yml)
  • Adds patch application workflow example (patch-during-build.yml)
  • Adds comprehensive "kitchen sink" example showing all major Dalec features (my-daemon.kitchensink.yml)

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.

File Description
docs/examples/hello.inline.yml Minimal example showing inline C source, gcc build, binary installation, and basic tests
docs/examples/config-and-systemd.yml Demonstrates daemon package layout with config files, createDirectories, and systemd unit packaging
docs/examples/patch-during-build.yml Shows how to apply patches during build phase with inline patch source
docs/examples/my-daemon.kitchensink.yml Comprehensive example demonstrating all major Dalec features including args, multiple source types, all artifact types, and extensive testing

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated no new comments.

@cpuguy83
Copy link
Collaborator

cpuguy83 commented Jan 5, 2026

@kartikjoshi21 Can you make sure to add the examples to

f = ["go-md2man"]
so that these get built as part of CI?

…temd, patching, kitchen-sink)

This PR adds several tutorial-style example specs under docs/examples/
to help new users understand how Dalec specs map to packages + images.

Fixes: project-dalec#828
Signed-off-by: Kartik Joshi <karikjoshi21@gmail.com>
@kartikjoshi21 kartikjoshi21 force-pushed the kartikjoshi21/learning-examples branch from 71b78bb to cbabfb1 Compare January 6, 2026 09:48
@kartikjoshi21
Copy link
Member Author

@kartikjoshi21 Can you make sure to add the examples to

f = ["go-md2man"]

so that these get built as part of CI?

@cpuguy83 added a patch for the same, Thanks

@cpuguy83 cpuguy83 merged commit 6650b98 into project-dalec:main Jan 7, 2026
38 of 44 checks passed
@kartikjoshi21 kartikjoshi21 deleted the kartikjoshi21/learning-examples branch January 8, 2026 06:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[REQ] add more examples

3 participants