Skip to content

Commit

Permalink
Update TILE_AUTHOR_GUIDE.md
Browse files Browse the repository at this point in the history
  • Loading branch information
notrepo05 authored and crhntr committed Jul 27, 2023
1 parent ec495a1 commit b3e4543
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions TILE_AUTHOR_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -350,7 +350,7 @@ The value of `remote_path` in the BOSH release tarball lock is a URL.

#### <a id='release-source-github'></a> GitHub Releases

Kiln can only download releases from GitHub Releases and can not upload BOSH Releases to BOSH.io.
Kiln can only download releases from GitHub Releases and can not upload BOSH Releases to Github.

To download BOSH Release Tarballs from GitHub Releases, add the following
```yaml
Expand Down Expand Up @@ -395,7 +395,9 @@ release_sources:
path_template: "some-path-template/{{.Name}}/{{.Name}}-{{.Version}}-{{.StemcellOS}}-{{.StemcellVersion}}.tgz"
```

Note `repo` is not a GitHub repository. It refers to an Artifactory repository.
Notes:
* `repo` is not a GitHub repository. It refers to an Artifactory repository.
* `username` and `password` values can be non-empty arbitrary values for read-only access

Please see [Path Templates](#path-templates). The value of `remote_path` in the BOSH release tarball lock is part of the path needed to construct a URL to download the release.

Expand Down Expand Up @@ -427,7 +429,7 @@ You can add a default credentials file to `~/.kiln/credentials.yml` so you don't
Don't do this with production creds but if you have credentials you can safely write to your disk, consider using this functionality.
The file can look like this
```yaml
# GitHub BOSH release tarball release sources credentials
# GitHub release sources credentials. Github Release should contain BOSH tarballs
github_token: some-token
# S3 release BOSH release tarball source credentials
Expand Down Expand Up @@ -481,14 +483,14 @@ _If I remember right, the find-stemcell-version command has a bug where the stem

## <a id="release-notes"></a> Tile Release Note Generation

If you use GitHub BOSH Release tarball sources,
If you use the GitHub release source for your BOSH release tarballs,
you can generate release notes for your tile.
The notes will contain release notes for each BOSH release.

This feature requires you to have a previous tile release that used a Kilnfile.lock to specify the BOSH releases packaged.
You pass two references
- the Git Reference or SHA of the commit of the source used to generate the previously published tile
- Git Reference or SHA of the commit of the source used to generate the **next** tile
- the Git Reference or SHA of the commit of the tile repo source used to generate the previously published tile
- Git Reference or SHA of the commit of the tile repo source used to generate the **next** tile

While you can override the template and the regular expression used to make these notes.
They are quite hard to craft.
Expand Down Expand Up @@ -598,4 +600,4 @@ The following are some useful .gitignore contents.
```.gitignore
releases/*.tgz
*.pivotal
```
```

0 comments on commit b3e4543

Please sign in to comment.