CHANGELOG.md

Change log

All notable changes to the ld-find-code-refs program will be documented in this file. This project adheres to Semantic Versioning.

[2.13.0] - 2024-12-18

Added:

• subdirectory option to set path to .launchdarkly/coderefs.yaml config file if not located in the root, in order to support monorepo subdirectories.

Changed:

• Updated dependencies

[2.12.0] - 2024-03-28

Added:

• Enable scanning of github workflow files #441

Changed:

• Streamline HTTP client used in requests #438

[2.11.10] - 2024-03-14

Changed:

• Use same http client with rate-limited retries for ld api client calls #437

[2.11.9] - 2024-03-04

Changed:

• Respect rate-limit headers during retries #434

[2.11.8] - 2024-02-13

Changed:

• Updated dependencies

Fixed:

• Multi-project scans now ignore projects without valid flags #430

[2.11.7] - 2024-01-31

Changed:

• Updated docker images to use alpine 3.19.1 (#426)

[2.11.6] - 2024-01-24

Changed:

• Dependencies updated

Fixed:

• Fixes index out of range error during extinction scanning #425

[2.11.5] - 2024-01-08

Added:

• Allow prune stage to be disabled #405

Changed:

• Disable branch pruning by default in GitHub action #405
• Dependency updates

[2.11.4] - 2023-10-16

Changed:

• Dependencies updated

[2.11.3] - 2023-09-20

Changed:

• Dependencies updated

Fixed:

• Docker image was not being built with correct alpine version (does not affect github or bitbucket integrations)

[2.11.2] - 2023-08-21

Fixed:

• Updates to release process

[2.11.1] - 2023-08-18

Changed:

• Update docker images

[2.11.0] - 2023-08-10

Changed:

• Update app to go 1.20
• Update dependencies

Fixed:

• Update module-path to v2 #362

[2.10.0] - 2023-02-21

Changed:

• Performance improvements around searching for flag extinctions in commit diffs, including changing search to use Aho-Corasick algorithm to find flags.
• Updated dependencies

Fixed:

• Error parsing git tag name when tag is annotated #329

[2.9.2] - 2023-02-16

Fixed:

• Bug introduced in 2.5.0 caused extinction scanning to run for hours and timeout.
• Typo in CircleCI orb caused failures

[2.9.1] - 2023-01-27

Fixed:

• CircleCI - pipeline exits with error when $BASH_ENV doesn't exist.

[2.9.0] - 2023-01-26

Added:

• CircleCI orb - manually source BASH_ENV since the orb uses sh entrypoint instead of bash

Changed:

• Update dependencies

Fixed:

• Monorepo configuration should not require that a dir be specified for each project key, as described in the documentation

[2.8.0] - 2022-11-10

Added:

• Support doublestar glob patterns in filepattern aliases

Changed:

• Update dependencies

[2.7.0] - 2022-09-14

Changed:

• Log a warning when a filepattern alias configuration does not match any files instead of failing
• Bumped dependencies

Fixed:

• Error running code refs when using a newer API token with version 20220603 and later.

[2.6.3] - 2022-09-09

Changed:

• update documentation
• bumped dependencies

[2.6.2] - 2022-09-06

Fixed:

• error running CircleCI orb

[2.6.1] - 2022-09-01

Fixed:

• git repo permissions in GitHub Action

[2.6.0] - 2022-08-31

Changed:

• gitlab is a supported repoType
• Optional defaultBranch will fallback to main when not provided, instead of master
• Bumped dependencies
• Added debug logging

[2.5.7] - 2022-03-01

Changed:

• Update release configuration

[2.5.6] - 2022-03-01

Fixed:

• Change in release process lead to build with incorrect docker image tag

[2.5.5] - 2022-03-01

Fixed:

• Slice bounds out of range error when saving hunks (#224)

Added:

• Enable builds for arm64 (#221)

[2.5.4] - 2022-02-16

Fixed

• Only a single flag per run was being searched for extinctions

Added

• extinctions command that will only generate and send extinctions using the lookback parameter

Changed

• Added additional examples for GitHub Action repo on how to configure the action

[2.5.3] - 2022-02-16

Fixed

• Only a single flag per run was being searched for extinctions

Added

• extinctions command that will only generate and send extinctions using the lookback parameter

Changed

• Added additional examples for GitHub Action repo on how to configure the action

[2.5.0] - 2022-02-04

Fixed:

• Snake case aliases we not being correctly generated due to bug in dependency.

Changed:

• If new projects block is used with CSV output, the first project key is used in the output file name. If still using projKey there is no change.

Added:

• Monorepo with starting directory support. More info can be read at Projects.

[2.4.1] - 2021-12-17

Fixed:

• Relative paths were not being expanded to an absolute path when used.

Changed:

• Find Code References GitHub Action is moving to semver versioning. Previously it was a major version that was incremented on every release of the underlying command line tool. Now the GitHub Action version will mirror the command line tooling version. This is moving it from v14 to v2.4.1

[2.4.0] - 2021-11-22

Changed:

• Performance improvements around searching for flags and aliases in the code base. Including changing search to use Aho-Corasick algorithm to find flags in file.
• If --dryRun is set, extinctions will not be attempted.

Added:

• --allowTags which allows Code Refs to run against a tag instead of the branch.

Fixed:

• Bug where alias filepattern's were not being validated. This meant ld-find-code-refs would run but if that file did not exist no aliases were generated.

[2.3.0] - 2021-11-02

Changed:

• Performance improvements around searching for flags and aliases in the code base.

[2.2.4] - 2021-06-14

Changed

• Matching flags with delimiters has been implemented in a more performant way.

[2.2.3] - 2021-05-26

Fixed

• File globbing for FilePattern alias support.

[2.2.2] - 2021-04-27

Added

• repoName is now a supported configuration option for github action and bitbucket pipes 🎉. This is especially useful for a monorepo where multiple yaml configurations exist, each mapping to its own LD project key.

[2.1.0]

Added

• ld-find-code-refs will now scan for archived flags.

[2.0.1] - 2020-10-05

Fixed

• Fixes a bug causing ld-find-code-refs to scan non-regular files, like symlinks. Thanks @d3d-z7n!

[2.0.0] - 2020-08-13

ℹ️ This release includes breaking changes to the command line tool. If you experience errors or unexpected behavior after upgrading, be sure to read these changelog notes carefully to make adjustments for any breaking changes.

Added

• Most command line flags can now be specified in a YAML file located in the .launchdarkly/coderefs.yaml subdirectory of your repository. docs
  • The following options cannot be specified in YAML, and must be set using the command line or as environment variables:
    • --dir / LD_DIR
    • --accessToken / LD_ACCESS_TOKEN
• All command line flags can now be specified as environment variables. docs
• When flags with no code references are detected, ld-find-code-refs will search Git commit history to detect when the last reference to a feature flag was removed. Use the --lookback command line flag to configure the number of commits you would like to search. The lookback will start at the current commit and will review up to the last n commits to find the last reference of the flag. The default is 10 commits.
• Added support for scanning non-git repositories. Use the --revision flag to specify your repository version number.
• Added the prune sub-command to delete stale code reference data from LaunchDarkly manually by providing a list of branch names as arguments. example: ld-find-code-refs prune [flags] "branch1" "branch2"
• The GitHub actions wrapper now supports the pull_request event

Fixed

• Exclude negations in .ldignore (lines beginning with an exclamation mark) now correctly include files.

Changed

• Command line arguments names have been improved. Now, a flag specified with a single dash indicates a shorthand name, while 2 dashes indicate the longform name. Some existing configurations may be invalid, see ld-find-code-refs --help for details.
• The default delimiters (single quotes, double quotes and backticks) can now be disabled in the coderefs.yaml configuration. docs. Delimiters can no longer be specified using command line flags or environment variables. If you use additional delimiters, or would like to disable delimiters completely, use YAML configuration instead.

Removed

• The exclude command-line option has been removed. Use the .ldignore file instead.
• ld-find-code-refs no longer requires the silver searcher (ag) as a runtime dependency.

[1.5.1] - 2020-05-22

Added

• Added support for specifying a custom default branch for the GitHub actions and Bitbucket pipes wrappers.

[1.5.0] - 2020-05-11

Added

• Added the ability to configure flag alias detection using a YAML configuration. See the README for instructions.

Fixed

• Improved logging around limitations.
• Fixed an edge case where false positives might be picked up for flag keys containing regular expression characters.

[1.4.0] - 2020-03-16

Added

• Added a --ignoreServiceErrors option to the CLI. If enabled, the scanner will terminate with exit code 0 when the LaunchDarkly API is unreachable or returns an unexpected response.

Changed

• ld-find-code-refs now requires go1.13 to build.

[1.3.1] - 2019-09-24

Fixed

• Fixed a regression causing no references to be found when a relative path is supplied to dir

[1.3.0] - 2019-09-19

Added

• Added a --outDir option to the CLI. If provided, code references will be written to a csv file in outDir.
• Added a --dryRun option to the CLI. If provided, ld-find-code-refs will scan for code references without sending them to LaunchDarkly. May be used in conjunction with --outDir to output code references data to a csv file instead of sending data to LaunchDarkly.

Fixed

• ld-find-code-refs now supports scanning repositories with a large number of flags using a pagination strategy. Thanks @cuzzasoft!
• Delimiters will now always be respected when searching for flags referenced in code. This fixes a bug causing references for certain flag keys to match against other flag keys that are substrings of the matched reference.

[1.2.0] - 2019-08-13

Added

• Added a --branch option to the CLI. This lets a branch name be manually specified when the repo is in a detached head state.
• GitHub actions v2 support: the github actions wrapper reads the branch name from GITHUB_REF and populates the branch option with it.

[1.1.1] - 2019-04-11

Fixed

• ld-find-code-refs will no longer exit with a fatal error when Git credentials have not been configured (required for branch cleanup). Instead, a warning will be logged.

[1.1.0] - 2019-04-11

Added

• ld-find-code-refs will now remove branches that no longer exist in the git remote from LaunchDarkly.

[1.0.1] - 2019-03-12

Changed

• Fixed a potential bug causing .ldignore paths to not be detected in some environments.
• When .ldignore is found, a debug message is logged.

[1.0.0] - 2019-02-21

Official release

[0.7.0] - 2019-02-15

Added

• Added support for Windows. ld-find-code-refs releases will now contain a windows executable.
• Added a new option -delimiters (-D for short), which may be specified multiple times to specify delimiters used to match flag keys.

Fixed

• The dir command line option was marked as optional, but is actually required. ld-find-code-refs will now recognize this option as required.
• ld-find-code-refs was performing extra steps to ignore directories for files in directories matched by patterns in .ldignore. This ignore process has been streamlined directly into the search so files in .ldignore are never scanned.

Changed

• The command-line docker image now specifies ld-find-code-refs as the entrypoint. See our documentation for instructions on running ld-find-code-refs via docker.
• ld-find-code-refs will now only match flag keys delimited by single-quotes, double-quotes, or backticks by default. To add more delimiters, use the delimiters command line option.

[0.6.0] - 2019-02-11

Added

• Added a new command line argument, version. If provided, the current ld-find-code-refs version number will be logged, and the scanner will exit with a return code of 0.
• The debug option is now available to the CircleCI orb.
• Added support for parsing .ldignore files specified in the root directory of the scanned repository. .ldignore may be used to specify a pattern (compatible with the .gitignore spec: https://git-scm.com/docs/gitignore#_pattern_format) for files to exclude from scanning.

Changed

• The internal API for specifying the default git branch (defaultBranch) has been changed. The defaultBranch argument on earlier versions of ld-find-code-refs will no longer do anything.

Fixed

• ld-find-code-refs will no longer error out if an unknown error occurs when scanning for code reference hunks within a file. Instead, an error will be logged.

[0.5.0] - 2019-02-01

Master

• Added support for parsing .ldignore files specified in the root directory of the scanned repository. .ldignore may be used to specify a pattern (compatible with the .gitignore spec: https://git-scm.com/docs/gitignore#_pattern_format) for files to exclude from scanning.

Added

• Generate deb and rpm packages when releasing artifacts.

Changed

• Automate Homebrew releases
• Added word boundaries to flag key regexes.
  • This should reduce false positives. E.g. for flag key cool-feature we will no longer match verycool-features.

[0.4.0] - 2019-01-30

Added

• Added support for relative paths to CLI -dir parameter.
• Added a new command line argument, debug, which enables verbose debug logging.
• ld-find-code-refs will now exit early if required dependencies are not installed on the system PATH.

Changed

• Renamed parse package to coderefs. The Parse() method in the aformentioned package is now Scan().

Fixed

• ld-find-code-refs will no longer erroneously make PATCH API requests to LaunchDarkly when url template parameters have not been configured.

[0.3.0] - 2019-01-23

Added

• Added openssh as a dependency for the command-line docker image.

Changed

• The default for contextLines is now 2. To disable sending source code to LaunchDarkly, set the contextLines argument to -1.
• Improved logging to provide more detailed summaries of actions performed by the scanner.

Fixed

• Fixed a bug in the CircleCI orb config causing contextLines to be a string parameter, instead of an integer.

Removed

• Removed the repoHead parameter. ld-find-code-refs now only supports scanning repositories already checked out to the desired branch.
• Removed an unnecessary dependency on openssh in Dockerfiles.

[0.2.1] - 2019-01-17

Fixed

• Fix a bug causing an error to be returned when a repository connection to LaunchDarkly does not initially exist on execution.

Removed

• Removed the cloneEndpoint command line argument. ld-find-code-refs now only supports scanning existing repository clones.

[0.2.0] - 2019-01-16

Fixed

• Use case-sensitive ag search so we don't get false positives that look like flag keys but have different casing.

Changed

• This project has been renamed to ld-find-code-refs.
• Logging has been overhauled.
• Project layout has been updated to comply with https://github.com/golang-standards/project-layout.
• updateSequenceId is now an optional parameter. If not provided, data will always be updated. If provided, data will only be updated if the existing updateSequenceId is less than the new updateSequenceId.
• Payload limits have been implemented
  • Flags with keys shorter than 3 characters are no longer supported.
  • Lines are truncated after 500 characters.
  • Search is terminated after 5,000 files are matched.
  • Search is terminated after 5,000 hunks are generated.
  • Number of hunks per file is limited to 1,000.
  • A file can only have 500 hunked lines per flag.
• Use launchdarkly docker hub namespace instead of ldactions.

[0.1.0] - 2019-01-02

Changed

• pushTime CLI arg renamed to updateSequenceId. Its type has been changed from timestamp to integer.
  • Note: this is not considered a breaking change as the CLI args are still in flux. After the 1.0 release arg changes will be considered breaking.

Fixed

• Upserting repos no longer fails on non-existent repos

[0.0.1] - 2018-12-14

Added

• Automated release pipeline for github releases and docker images
• Changelog