Skip to content

Add documentation for runner GIT_SUBMODULE_UPDATE_FLAGS

What does this MR do?

This is a companion MR adding documentation for the implementation of GIT_SUBMODULE_UPDATE_FLAGS in Add support for extra submodule update flags (gitlab-runner!3192 - merged).

I based this off the GIT_FETCH_EXTRA_FLAGS section just above this one.

@ajwalker you may want to have a quick look at this as we already discussed the flag overlap in the implementation MR. Luckily, a similar situation happens with the fetch extra flags, so I was able to document it mostly the same way.

Related issues

gitlab CI not checking out latest submodule's c... (gitlab-runner#3011 - closed),
Run git submodule update --force (gitlab-runner#27277 - closed).

Author's checklist

If you are 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.

Review 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 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.
    • 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 reviews above. Maintainer's review can occur before or after a technical writer review.
  • Ensure a release milestone is set.

🛠 with at Siemens

Edited by Nejc Habjan

Merge request reports