Skip to content

Commit 4171e9e

Browse files
authored
polish README (#442)
Signed-off-by: Kenneth Bingham <[email protected]>
1 parent 87592e8 commit 4171e9e

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -258,7 +258,7 @@ git-upload-url: https://uploads.github.com/
258258
cr upload --config config.yaml
259259
```
260260

261-
`cr` supports any format [Viper](https://github.com/spf13/viper) can read, i. e. JSON, TOML, YAML, HCL, and Java properties files.
261+
`cr` supports any format [Viper](https://github.com/spf13/viper) can read, i.e. JSON, TOML, YAML, HCL, and Java properties files.
262262

263263
Notice that if no config file is specified, `cr.yaml` (or any of the supported formats) is loaded from the current directory, `$HOME/.cr`, or `/etc/cr`, in that order, if found.
264264

@@ -279,7 +279,7 @@ and then look for `upload_url`. You need the part of the URL that appears before
279279

280280
## Common Error Messages
281281

282-
During the upload, you can get the follwing error :
282+
During the upload, you can get the following error :
283283

284284
```bash
285285
422 Validation Failed [{Resource:Release Field:tag_name Code:already_exists Message:}]
@@ -289,8 +289,8 @@ You can solve it by adding the `--skip-existing` flag to your command. More deta
289289

290290
## Known Bug
291291

292-
Currently, if you set the upload URL incorrectly, let's say to something like `https://example.com/uploads/`, then `cr upload` will appear to work, but the release will not be complete. When everything is working there should be 3 assets in each release, but instead there will only be the 2 source code assets. The third asset, which is what helm actually uses, is missing. This issue will become apparent when you run `cr index` and it always claims that nothing has changed, because it can't find the asset it expects for the release.
292+
Currently, if you set the upload URL incorrectly, let's say to something like `https://example.com/uploads/`, then `cr upload` will appear to work, but the release will not be complete. When everything is working there should be three assets in each release, but instead, there will only be two source code assets. The third asset is missing and is needed by Helm. This issue will become apparent when you run `cr index` and it always claims that nothing has changed, because it can't find the asset it expects for the release.
293293

294-
It appears like the [go-github Do call](https://github.com/google/go-github/blob/master/github/github.go#L520) does not catch the fact that the upload URL is incorrect and pass back the expected error. If the asset upload fails, it would be better if the release was rolled back (deleted) and an appropriate log message is be displayed to the user.
294+
It appears like the [go-github Do call](https://github.com/google/go-github/blob/master/github/github.go#L520) does not catch the fact that the upload URL is incorrect and passes back the expected error. If the asset upload fails, it would be better if the release was rolled back (deleted) and an appropriate log message is displayed to the user.
295295

296296
The `cr index` command should also generate a warning when a release has no assets attached to it, to help people detect and troubleshoot this type of problem.

0 commit comments

Comments
 (0)