Skip to content

Commit

Permalink
docs: Updated readme with re-bake and bake --final info
Browse files Browse the repository at this point in the history
- Also fixed --help argument for re-bake command

Authored-by: Ramkumar Vengadakrishnan <ramkumar.vengadakrishnan@broadcom.com>
  • Loading branch information
ram-pivot committed Mar 22, 2024
1 parent 8211c78 commit fd2837f
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 1 deletion.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,7 @@ Commands:
glaze Pin versions in Kilnfile to match lock.
help prints this usage information
publish publish tile on Pivnet
re-bake re-bake constructs a tile from a bake record
release-notes generates release notes from bosh-release release notes
sync-with-local update the Kilnfile.lock based on local releases
test Test manifest for a product
Expand Down Expand Up @@ -224,6 +225,13 @@ tile. There are very few reasons a tile developer should want to do this, but if
you do, you can include these extra files here. The flag can be specified
multiple times to embed multiple files or directories.

##### `--final`

The `--final` flag is to bake a final release tile. When passing the --final flag,
Kiln creates a baked record file with metadata like source revision SHA, tile version, kiln version and
file checksums. This bake record file will be created under bake_records folder. This
bake record file can later be used to re-bake the tile.

##### `--forms-directory`

The `--forms-directory` flag takes a path to a directory that contains one
Expand Down Expand Up @@ -519,7 +527,16 @@ provides_product_versions:
```
</details>
### `re-bake`
It constructs a tile from a given bake record file.
To run the command, you simply need to be within a tile directory and execute the following command:
```
$ kiln re-bake --output-file tile.pivotal bake_records/1.0.0.json
```
Any variables that Kilnfile needs for the kiln re-bake command should be set in
~/.kiln/credentials.yml file
### `test`
Expand Down
2 changes: 1 addition & 1 deletion internal/commands/rebake.go
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,6 @@ func (cmd ReBake) Usage() jhanda.Usage {
return jhanda.Usage{
Description: "re-bake (aka record bake) builds a tile from a bake record. You must check out the repository to the revision of the source_revision in the bake record before running this command.",
ShortDescription: "re-bake constructs a tile from a bake record",
Flags: &cmd.Options,
Flags: cmd.Options,
}
}

0 comments on commit fd2837f

Please sign in to comment.