Skip to content

Deprecated Tools

deprecatedFilePrependVersion

Take a deprecated.txt file and add a comment with the

Usage

deprecatedFilePrependVersion target version

Take a deprecated.txt file and add a comment with the current version number to the top

Arguments

  • target - File. Required. File to update.
  • version - String. Required. Version to place at the top of the file.

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

deprecatedIgnore

Output a list of tokens for find to ignore in

Usage

deprecatedIgnore

Output a list of tokens for find to ignore in deprecated calls Skips dot directories and release notes by default and any file named deprecated.sh deprecated.txt or deprecated.md.

Arguments

  • none

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

Environment

  • BUILD_RELEASE_NOTES - ApplicationDirectory. Constant for the release notes path. Defaults to ./docs/release.

deprecatedCannonFile

Run cannon using a configuration file or files.

Usage

deprecatedCannonFile findArgumentFunction cannonFile

Run cannon using a configuration file or files. Comment lines (First character is #) are considered the current "state" (e.g. version) and are displayed during processing.

Sample file:

# v0.25.0
timingStart|timingStart
timingReport|timingReport
bashUserInput|bashUserInput

# v0.24.0
listJoin|listJoin
mapTokens|mapTokens

Return Code: 0 - No changes were made in any files. Return Code: 1 - changes were made in at least one file.

Arguments

  • findArgumentFunction - Function. Required. Find arguments (for find) for cannon.
  • cannonFile - File. Required. One or more files delimited with | characters, one per line search|replace|findArguments|.... If not files are supplied then pipe file via stdin.

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

deprecatedFind

Find files which match a token or tokens

Usage

deprecatedFind findArgumentFunction search [ --path cannonPath ]

Find files which match a token or tokens Return Code: 0 - One of the search tokens was found in a file (which matches find arguments) Return Code: 1 - Search tokens were not found in any file (which matches find arguments)

Arguments

  • findArgumentFunction - Function. Required. Find arguments (for find) for cannon.
  • search - String. Required. String to search for (one or more)
  • --path cannonPath - Optional. Directory. Run cannon operation starting in this directory.

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

deprecatedCannon

undocumented

Usage

deprecatedCannon [ --path cannonPath ] findArgumentFunction search replace [ extraCannonArguments ]

No documentation for deprecatedCannon.

Arguments

  • --path cannonPath - Optional. Directory. Run cannon operation starting in this directory.
  • findArgumentFunction - Function. Required. Find arguments (for find) for cannon.
  • search - String. Required. String to search for
  • replace - EmptyString. Required. Replacement string.
  • extraCannonArguments - Arguments. Optional. Any additional arguments are passed to cannon.

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

deprecatedTokensFile

Run deprecated tokens file search

Usage

deprecatedTokensFile

Run deprecated tokens file search

Arguments

  • none

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error