Skip to content

Expand and consolidate Git LFS docs for non-docker executors

Nejc Habjan requested to merge gitlab-community/gitlab-runner:docs/git-lfs-executors into main

What does this MR do?

We had a user report that LFS was being skipped on clone even though it's installed on the runner machine (shell executor):

Checking out xxxx as main...

git-lfs/2.9.0 (GitHub; windows amd64; go 1.12.7; git 8ab05aa7)

Skipping object checkout, Git LFS is not installed.

This MR adds the missing git lfs install instructions if people really want to use LFS on these executors. But I noticed that since the initial instructions were added across several different executors (see 655a956f), they have since drifted a bit. This puts them into one place and links from all non-docker executors.

This MR is also a little test of the community fork for me 😅

Related issues

Potentially part of this could be automated by the runner. I wonder if Git LFS tests failing for cmd/powershell (#4107) is a result of this (i.e. lfs is not initialized properly on the host). Forcing a local lfs install would also help with things like CI runner breaks on activated git-lfs (improved... (#2504). Maybe I could take a stab at that at some point.

Author's checklist

If you are a GitLab team member and only adding documentation, do not add any of the following labels:

  • ~"frontend"
  • ~"backend"
  • ~"type::bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Reviewer's checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

If you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • Ensure a release milestone is set.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
Edited by Nejc Habjan

Merge request reports