Skip to content
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

update readme for supported flags #220

Merged
merged 2 commits into from
Jul 4, 2023
Merged

update readme for supported flags #220

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
422c3b3
update readme for supported flags
davidgamero Jul 3, 2023
510f837
extra word
davidgamero Jul 3, 2023
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
11 changes: 5 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,6 @@ The following flags can be used for enabling dry running, which is currently sup
"NAMESPACE": "default",
"PORT": "1323",
"SERVICEPORT": "80",
"VERSION": "1.18"
},
"filesToWrite": [
"langtest/.dockerignore",
Expand All @@ -125,7 +124,7 @@ The following flags can be used for enabling dry running, which is currently sup
```
## Prerequisites

Draft requires Go version 1.18.x.
Draft requires Go version 1.18.x. or above as it uses go generics

Check your go version.

Expand Down Expand Up @@ -179,17 +178,17 @@ If you are looking to leverage Draft's file generation capabilities and templati
### Importing Draft Go Packages
This option will provide the cleanest integration, as it directly builds Draft into your project. However, it requires that your project is written in Go.

Dockerfiles can be generated following the example in `examples/dockerfile.go`
Dockerfiles can be generated following the example in [examples/dockerfile.go](https://github.com/Azure/draft/blob/main/example/dockerfile.go)

Deployment files can be generated following the example in `examples/deployment.go`
Deployment files can be generated following the example in [examples/deployment.go](https://github.com/Azure/draft/blob/main/example/deployment.go)

### Wrapping the Binary
For projects written in languages other than Go, or for projects that prefer to not import the packages directly, you can wrap the Draft binary.

Several features have been implemented to make consuming draft as easy as possible:
- `draft info` prints supported language and field information in json format for easy parsing
- `--dry-run` and `--dry-run-file` flags can be used on the `create` command to generate a summary of the files that would be written to disk, and the variables that would be used in the templates
- `draft update` accepts takes a repeatable `--variable` flag that can be used to set template variables
- `--dry-run` and `--dry-run-file` flags can be used on the `create` and `update` commands to generate a summary of the files that would be written to disk, and the variables that would be used in the templates
- `draft update` and `draft create` accept a repeatable `--variable` flag that can be used to set template variables
- `draft create` takes a `--create-config` flag that can be used to input variables through a yaml file instead of interactively

## Contributing
Expand Down