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.

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

Improve command names, help output, and package layout #334

Draft
wants to merge 20 commits into
base: main
Choose a base branch
from

Conversation

crhntr
Copy link
Member

@crhntr crhntr commented Sep 23, 2022

This is part of Kiln 1.0.

@cf-gitbot
Copy link
Member

We have created an issue in Pivotal Tracker to manage this. Unfortunately, the Pivotal Tracker project is private so you may be unable to view the contents of the story.

The labels on this github issue will be updated when the story is started.

@crhntr crhntr changed the title **[feature]** Improve command names, help output, and package layout Improve command names, help output, and package layout Sep 23, 2022
@crhntr crhntr force-pushed the feature/better-command-names--help-ouput--and-package-layout branch from 2806180 to 3362e3b Compare September 23, 2022 23:17
@crhntr crhntr added this to the Kiln 1.0 milestone Sep 23, 2022
this is a strange command to have here.
We create the pivnet release in an internal then come back to kiln to publish it.
This makes more sense in ppet. It has been moved there.
…ign document

https://3.basecamp.com/4957863/buckets/28333123/documents/5176885360

I made some deviations from the document.

- i removed publish (tile). it is now in ppet (see previous commit)
- added a line of "=" after the title
- changed some of the whitespace/lines

here is the document's suggestions:
-----

kiln
Kiln helps you manage, assemble and update OpsManager-compatible Tiles

Component Team Commands:
publish-release                Makes Bosh Release available for inclusion in Tiles
update-release                 Updates Lockfile to specified Bosh Release satisfying Kilnfile constraint

Tile Commands:
bake                           Assembles a Tile suitable for OpsManager consumption
create-release-notes           Collects GitHub Release notes for Tile Components
publish                        Adds dates (release and EOGS) and license files to Tile Product on Pivnet
validate                       Checks for common Kilnfile and Lockfile mistakes

Component Commands:
cache-releases                 Compiles uncompiled Bosh Releases, makes them available to PPE team for inclusion in Published Tiles
fetch-releases                 Downloads Bosh Releases listed in Lockfile
find-release-version           Prints latest Bosh Release version satisfying Kilnfile constraint
find-stemcell-version          Prints latest Stemcell version on Pivnet satisfying Kilnfile constraint
update-stemcell                Updates Lockfile to latest Stemcell satisfying Kilnfile constraint

Global Commands:
help                           Prints this usage information
version                        Prints Kiln version
I also made the tests table driven.
I also cleaned up the package API.
I ran go mod tidy.
I also ran gofumpt
@crhntr crhntr force-pushed the feature/better-command-names--help-ouput--and-package-layout branch from 18a4946 to 6c4cf73 Compare October 13, 2022 17:30
@crhntr crhntr force-pushed the feature/better-command-names--help-ouput--and-package-layout branch from 6c4cf73 to 6fef6aa Compare October 13, 2022 17:34
@crhntr crhntr marked this pull request as draft May 27, 2023 00:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants