Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Proposal - We can use Github CLI since it has commands we need like manually triggering the workflow. Also we can create custom commands.
GitHub CLI documentation - GitHub Docs

Plan - We will create our custom CLI, which can wrap around many of the gh cli commands that we expect will be used.

Temporary Location: BuildSystem/bs_cli at main · ad-build-test/BuildSystem (github.com)

Proposed list of additional CLI commands/operations:

  • create related GH Issue (or JIRA) based on given CATER
  • create new repo from template
    • Command is there, need to create the template(s). 
  • checkout component repo
  • create bugfix branch from designated branch/tag/commit
  • Run workflow:
    • build - locally or remotely
    • deploy - specific location
    • test - locally or at specific location
  • mark bugfix branch as ready for official/final review
  • tag management
    • create
    • modify
    • mark as bad
    • delete

Introduction:

This command allows for auto completion (Shell Completion — Click Documentation (8.1.x) (palletsprojects.com):

Code Block
eval "$(_BS_COMPLETE=bash_source bs)"

Example:
Image Added

TODO: See if we can add it to every user's .bashrc (or maybe just call that within the CLI once)

Current:

  1. work on cli - plan of making our own, but can use gh cli as one of tools
    1. Make our own cli - can use python (for ease of development, and speed is not important since its ran from a dev's machine as just another process)
    2. Use GNU Coding Standards section 4.8 'standards for command line interfaces'
    3. Currently have a structure laid out, and have some commands available