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.

Sign up for GitHub

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

Jump to bottom

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

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

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

wants to merge 20 commits into from

Commits on Oct 13, 2022

  1. refactor(commands)!: remove publish command 

    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.
    @crhntr
    crhntr committed Oct 13, 2022
    Configuration menu
    Copy the full SHA
    2a65fac View commit details
    Browse the repository at this point in the history

  2. refactor(command)!: change command names and help output to match des… 

    …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
    @crhntr
    crhntr committed Oct 13, 2022
    Configuration menu
    Copy the full SHA
    4670623 View commit details
    Browse the repository at this point in the history

  3. refactor: organize main.go

    @crhntr
    crhntr committed Oct 13, 2022
    Configuration menu
    Copy the full SHA
    b2f2c53 View commit details
    Browse the repository at this point in the history

  4. refactor: make major version extractor private 

    I also made the tests table driven.
    @crhntr
    crhntr committed Oct 13, 2022
    Configuration menu
    Copy the full SHA
    0a1bd54 View commit details
    Browse the repository at this point in the history

  5. refactor: use public constant from pivnet package for host

    @crhntr
    crhntr committed Oct 13, 2022
    Configuration menu
    Copy the full SHA
    1d2da61 View commit details
    Browse the repository at this point in the history

  6. docs: tools package

    @crhntr
    crhntr committed Oct 13, 2022
    Configuration menu
    Copy the full SHA
    14c8d92 View commit details
    Browse the repository at this point in the history

  7. refactor: rename package "internal/release" to "pkg/notes" 

    I also cleaned up the package API.
I ran go mod tidy.
I also ran gofumpt
    @crhntr
    crhntr committed Oct 13, 2022
    Configuration menu
    Copy the full SHA
    00fedb3 View commit details
    Browse the repository at this point in the history

  8. refactor: move manifest generation from pkg/cargo to pkg/manifest

    @crhntr
    crhntr committed Oct 13, 2022
    Configuration menu
    Copy the full SHA
    c9d8339 View commit details
    Browse the repository at this point in the history

  9. refactor: use dot import instead of non-ascii character Ω 

    This makes it easier for non-mac users to contribute.
    @crhntr
    crhntr committed Oct 13, 2022
    Configuration menu
    Copy the full SHA
    550414b View commit details
    Browse the repository at this point in the history

  10. fix: brittle acceptance test 

    the version constraint on stemcells does not limit the version...
    @crhntr
    crhntr committed Oct 13, 2022
    Configuration menu
    Copy the full SHA
    f955234 View commit details
    Browse the repository at this point in the history

  11. feature: better document default paths 

    this also fixes a bunch of awkward issues that came from default paths and default values being mixed up
    @crhntr
    crhntr committed Oct 13, 2022
    Configuration menu
    Copy the full SHA
    687ca64 View commit details
    Browse the repository at this point in the history

  12. feature: help groups can be ordered 

    Co-authored-by: Steve Taylor <[email protected]>
    @crhntr @staylor14
    crhntr and staylor14 committed Oct 13, 2022
    Configuration menu
    Copy the full SHA
    c62e301 View commit details
    Browse the repository at this point in the history

  13. refactor: move proofing and manifest to internal directory

    @crhntr
    crhntr committed Oct 13, 2022
    Configuration menu
    Copy the full SHA
    4310452 View commit details
    Browse the repository at this point in the history

  14. fix: failure when the bucket is already empty

    @crhntr
    crhntr committed Oct 13, 2022
    Configuration menu
    Copy the full SHA
    ca60f07 View commit details
    Browse the repository at this point in the history

  15. fix: incorrectly registered commands

    @crhntr
    crhntr committed Oct 13, 2022
    Configuration menu
    Copy the full SHA
    836cc30 View commit details
    Browse the repository at this point in the history

  16. fix: make error message better

    @crhntr
    crhntr committed Oct 13, 2022
    Configuration menu
    Copy the full SHA
    6b2d0f8 View commit details
    Browse the repository at this point in the history

  17. fix: golangci-lint

    @crhntr
    crhntr committed Oct 13, 2022
    Configuration menu
    Copy the full SHA
    73fd273 View commit details
    Browse the repository at this point in the history

  18. gofumpt

    @crhntr
    crhntr committed Oct 13, 2022
    Configuration menu
    Copy the full SHA
    c62a793 View commit details
    Browse the repository at this point in the history

  19. make commands use pointer reciever

    @crhntr
    crhntr committed Oct 13, 2022
    Configuration menu
    Copy the full SHA
    a99a7b5 View commit details
    Browse the repository at this point in the history

  20. fix: cmd bake uses ptr rcvr

    @crhntr
    crhntr committed Oct 13, 2022
    Configuration menu
    Copy the full SHA
    6fef6aa View commit details
    Browse the repository at this point in the history