/jx-helpers

a library of common helper utilities for working with commands and git

Primary LanguageGoApache License 2.0Apache-2.0

jx-helpers

Documentation Go Report Card Releases LICENSE Slack Status

jx-helpers is a small library of helper functions for working with the commands, git, scm and kubernetes

Refactoring notes

If you are refactoring code from the v2 branch of jenkins-x/jx out into a separate library/microservice here's some tips on switching code over to jx-helpers

The util package has been split up into separate packages:

Files:

  • util.Copy* => files.Copy*
  • util.Dir* => files.Dir*
  • util.File* => files.File*
  • util.IO* => files.IO*
  • util.Un* => files.Un*

Strings:

  • util.String* => stringhelpers.String*
  • util.Url* => stringhelpers.Url*

Git:

  • gits.Gitter => gitclient.Interface then the git commands are simple CLI arguments like:
results, err := gitClient.Command(dir, "commit", "-a", "-m", "my message")

Cobra:

  • cmd/* => cobras/*