Skip to content
This repository has been archived by the owner on Nov 22, 2022. It is now read-only.

Update docs for glab pipeline run to include variables parameter #885

Merged
merged 1 commit into from
Oct 28, 2021

Conversation

junderhill
Copy link

@junderhill junderhill commented Oct 21, 2021

Description

Updated docs to include example and description of --variables for glab pipeline run command.

How Has This Been Tested?

Docs - Not applicable.

Screenshots (if appropriate)

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation
  • Chore (Related to CI or Packaging to platforms)

@codecov
Copy link

codecov bot commented Oct 21, 2021

Codecov Report

Merging #885 (1951791) into trunk (74d6d07) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##            trunk     #885   +/-   ##
=======================================
  Coverage   59.29%   59.29%           
=======================================
  Files          93       93           
  Lines        7383     7383           
=======================================
  Hits         4378     4378           
  Misses       2619     2619           
  Partials      386      386           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 74d6d07...1951791. Read the comment docs.

Copy link
Owner

@profclems profclems left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You’re not supposed to update the doc files directly. They are automatically generated at release. You can add the example directly to the command here:

Example: heredoc.Doc(`
$ glab ci run
$ glab ci run -b trunk
`),

@junderhill
Copy link
Author

@profclems apologies - I didn't realise they were auto generated, very nice 👍 I've updated the pull request

@zemzale
Copy link
Collaborator

zemzale commented Oct 28, 2021

Since the manually added docs have been removed which I will merge the MR. I don't seem to find a way how I can resolve @profclems change request, but this looks good @junderhill. Thanks for this.

@zemzale zemzale merged commit 42db084 into profclems:trunk Oct 28, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants