Error: Parsing git branch name about find-code-references

[vlymar]

${GITHUB_REF:11}? is that a typo or is that really what's needed?

Sadly it is not a typo 😄 . It's a bash trick for string manipulation, basically says "return $GITHUB_REF starting at character position 11 (trims off refs/heads/)."

I'm currently working on first class support for Github actions v2 for ld-find-code-refs, so I'd recommend waiting for that to land. I expect to have it ready this week.

Edit: see "Substring Extraction" on https://www.tldp.org/LDP/abs/html/string-manipulation.html

[HoughIO]

You're a beast!
Thanks for your support!

[vlymar]

Hi @HoughIO, thanks for the report. We were internally aware of this issue but dropped the ball on addressing it.

As you've already determined, github actions v2 contains a breaking change. v1 cloned the repo into the action container and checked it out to the correct branch. v2 removes this functionality and asks the user to manually include the actions/checkout step. Unfortunately that action leaves the repo in a detached head state rather than checked out to a branch, like in v1.

The fix is simple - we need ld-find-code-refs to read the branch name from $GITHUB_REF rather than try to get it from git as we do now. Until we make that change, there is a hacky workaround for getting this v2 action to work. You could add the following action in between actions/checkout and the code references action:

- name: Prepare repository
  run: git checkout "${GITHUB_REF:11}"

This just gets the repo out of the detached head state so the current version of ld-find-code-refs can run.

My recommendation would be to wait on using this v2 action until we have shipped v2 compatibility to ld-find-code-refs. I will post again to this issue when that is done.

Thanks, and apologies for the trouble.

[victorquinn]

${GITHUB_REF:11}? is that a typo or is that really what's needed?

[HoughIO]

Although taking another look at this, the new format requires the codebase to be cloned with the actions/checkout@v1 action located here. Which seems to not be a specific branch, but checks out the ref based on the pull request data sent in the payload.

[HoughIO]

That's a good hack!
GITHUB_REF

The branch or tag ref that triggered the workflow. For example, refs/heads/feature-branch-1. If neither a branch or tag is available for the event type, the variable will not exist.
--

So it would be the current branch!
Neat!

[victorquinn]

Slick!

[vlymar]

This issue is fixed in the v2 release of find-code-references.

If you update your workflows to uses: launchdarkly/find-code-references@v2 things should just work.

Thanks for the reports!