Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update help text with suggestions from docs code review #2313

Merged

Conversation

triarius
Copy link
Contributor

You may be wondering about the removal of line breaks from the code examples. This was done to reflected changes in the docs. It seems to still look good for the cli:

Usage:

   buildkite-agent lock release [key] [token]

Description:
   Releases the lock for the given key. This should only be called by the
   process that acquired the lock. To help prevent different processes unlocking
   each other unintentionally, the output from ′lock acquire′ is required as the
   second argument.

   Note that this subcommand is only available when an agent has been started
   with the ′agent-api′ experiment enabled.

Examples:

   #!/bin/bash
   token=$(buildkite-agent lock acquire llama)
   # your critical section here...
   buildkite-agent lock release llama "${token}"

Options:

   --no-color            Don't show colors in logging [$BUILDKITE_AGENT_NO_COLOR]
   --debug               Enable debug mode. Synonym for ′--log-level debug′. Takes precedence over ′--log-level′ [$BUILDKITE_AGENT_DEBUG]
   --log-level value     Set the log level for the agent, making logging more or less verbose. Defaults to notice. Allowed values are: debug, info, error, warn, fatal (default: "notice") [$BUILDKITE_AGENT_LOG_LEVEL]
   --experiment value    Enable experimental features within the buildkite-agent [$BUILDKITE_AGENT_EXPERIMENT]
   --profile value       Enable a profiling mode, either cpu, memory, mutex or block [$BUILDKITE_AGENT_PROFILE]
   --config value        Path to a configuration file [$BUILDKITE_AGENT_CONFIG]
   --lock-scope value    The scope for locks used in this operation. Currently only 'machine' scope is supported (default: "machine") [$BUILDKITE_LOCK_SCOPE]
   --sockets-path value  Directory where the agent will place sockets (default: "/home/narthana/.buildkite-agent/sockets") [$BUILDKITE_SOCKETS_PATH]

@triarius triarius requested a review from a team August 22, 2023 06:59
@triarius triarius changed the title Update help text with suggests from docs code review Update help text with suggestions from docs code review Aug 22, 2023
Copy link
Contributor

@DrJosh9000 DrJosh9000 left a comment

Choose a reason for hiding this comment

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

😅😅😅

@@ -11,7 +11,7 @@ import (

const lockDoneHelpDescription = `Usage:

buildkite-agent lock release [key]
buildkite-agent lock done [key]
Copy link
Contributor

Choose a reason for hiding this comment

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

😅

@@ -26,7 +26,7 @@ Description:

Examples:

Unsetting the variables ′LLAMA′ and ′ALPACA′)
Unsetting the variables ′LLAMA′ and ′ALPACA′:
Copy link
Contributor

Choose a reason for hiding this comment

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

😅

@triarius triarius merged commit 862cfd9 into main Aug 22, 2023
1 check passed
@triarius triarius deleted the pdp-1496-update-agent-help-with-feedback-from-docs-for-v3510 branch August 22, 2023 07:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants