Skip to content

Commit

Permalink
--help text
Browse files Browse the repository at this point in the history
  • Loading branch information
jwodder committed Oct 19, 2023
1 parent ba95baf commit a80af74
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ use log::{Level, LevelFilter};
use std::io;
use std::path::PathBuf;

/// Create & enforce sets of labels in GitHub repositories
///
/// See <https://github.com/jwodder/labelmaker> for more information
#[derive(Clone, Debug, Eq, Parser, PartialEq)]
#[clap(version)]
struct Arguments {
Expand All @@ -32,15 +35,31 @@ struct Arguments {

#[derive(Clone, Debug, Eq, PartialEq, Subcommand)]
enum Command {
/// Apply a set of label specifications to GitHub repositories
Apply {
/// Do not change anything in GitHub, but do emit log messages showing
/// what would be changed.
#[arg(long)]
dry_run: bool,

/// Specify which profile in the configuration file to use. Defaults
/// to the value of `defaults.profile` in the configuration file, or to
/// `default`.
#[arg(short = 'P', long, value_name = "NAME")]
profile: Option<String>,

/// A configuration file describing what labels to create and/or update
/// in each repository
config: PathBuf,

/// The GitHub repositories to operate on.
///
/// Repositories can be specified in the form `OWNER/NAME` (or, when
/// `OWNER` is the authenticating user, just `NAME`) and/or as GitHub
/// repository URLs.
///
/// If no repositories are specified, then the GitHub repository for
/// the local Git repository is used.
repository: Vec<String>,
},
}
Expand Down

0 comments on commit a80af74

Please sign in to comment.