Skip to content

chore(docs): add provider schema #39

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 21, 2024
Merged

chore(docs): add provider schema #39

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b68d766
chore(docs): add provider schema
johnstcn Aug 21, 2024
d4b8665
apply suggestions from code review
johnstcn Aug 21, 2024
5a45cc5
rm duplicate heading
johnstcn Aug 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,19 @@
page_title: "envbuilder Provider"
subcategory: ""
description: |-

Envbuilder Provider
The Envbuilder provider can be used to check for the presence of a Docker image previously built by Envbuilder https://github.com/coder/envbuilder.
This allows re-using a previously built image pushed to a Docker registry without having to rebuild it.
An image built by Envbuilder also embeds the Envbuilder binary inside the image, allowing for the image to be used to build other images.
---

# envbuilder Provider

# Envbuilder Provider

The Envbuilder provider can be used to check for the presence of a Docker image previously built by [Envbuilder](https://github.com/coder/envbuilder).
This allows re-using a previously built image pushed to a Docker registry without having to rebuild it.
An image built by Envbuilder also embeds the Envbuilder binary inside the image, allowing for the image to be used to build other images.

## Example Usage

Expand Down
6 changes: 6 additions & 0 deletions internal/provider/provider.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,12 @@ func (p *EnvbuilderProvider) Metadata(ctx context.Context, req provider.Metadata
func (p *EnvbuilderProvider) Schema(ctx context.Context, req provider.SchemaRequest, resp *provider.SchemaResponse) {
resp.Schema = schema.Schema{
Attributes: map[string]schema.Attribute{},
MarkdownDescription: `# Envbuilder Provider

The Envbuilder provider can be used to check for the presence of a Docker image previously built by [Envbuilder](https://github.com/coder/envbuilder).
This allows re-using a previously built image pushed to a Docker registry without having to rebuild it.
An image built by Envbuilder also embeds the Envbuilder binary inside the image, allowing for the image to be used to build other images.
`,
}
}

Expand Down