From 46c014d087537d275c8b0cbe9458d09f46addb03 Mon Sep 17 00:00:00 2001 From: Nick Rohn Date: Thu, 27 Jul 2023 10:20:15 -0700 Subject: [PATCH] Update TILE_AUTHOR_GUIDE.md --- TILE_AUTHOR_GUIDE.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/TILE_AUTHOR_GUIDE.md b/TILE_AUTHOR_GUIDE.md index 9fba494be..92ef4831f 100644 --- a/TILE_AUTHOR_GUIDE.md +++ b/TILE_AUTHOR_GUIDE.md @@ -350,7 +350,7 @@ The value of `remote_path` in the BOSH release tarball lock is a URL. #### 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 @@ -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. @@ -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 @@ -481,14 +483,14 @@ _If I remember right, the find-stemcell-version command has a bug where the stem ## 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. @@ -598,4 +600,4 @@ The following are some useful .gitignore contents. ```.gitignore releases/*.tgz *.pivotal -``` \ No newline at end of file +```