style(args)!: rename --commit-path argument to --include-path

README.md

@@ -149,7 +149,7 @@ git-cliff [FLAGS] [OPTIONS] [RANGE]
 -c, --config <PATH>               Sets the configuration file [env: CONFIG=]  [default: cliff.toml]
 -w, --workdir <PATH>              Sets the working directory [env: WORKDIR=]
 -r, --repository <PATH>           Sets the git repository [env: REPOSITORY=]
-    --commit-path <PATTERN>...    Sets the path to include related commits [env: COMMIT_PATH=]
+    --include-path <PATTERN>...   Sets the path to include related commits [env: INCLUDE_PATH=]
     --exclude-path <PATTERN>...   Sets the path to exclude related commits [env: EXCLUDE_PATH=]
 -p, --prepend <PATH>              Prepends entries to the given changelog file [env: PREPEND=
 -o, --output <PATH>               Writes output to the given file [env: OUTPUT=]
@@ -208,7 +208,7 @@ git cliff HEAD~2..
 Generate a changelog scoped to a specific directory (useful for monorepos):
 
 ```sh
-git cliff --commit-path "**/*.toml" --commit-path "*.md"
+git cliff --include-path "**/*.toml" --include-path "*.md"
 git cliff --exclude-path ".github/*"
 ```
 

git-cliff/src/args.rs

@@ -39,7 +39,7 @@ pub struct Opt {
 	pub repository:   Option<PathBuf>,
 	/// Sets the path to include related commits.
 	#[structopt(long, env, value_name = "PATTERN")]
-	pub commit_path:  Option<Vec<Pattern>>,
+	pub include_path: Option<Vec<Pattern>>,
 	/// Sets the path to exclude related commits.
 	#[structopt(long, env, value_name = "PATTERN")]
 	pub exclude_path: Option<Vec<Pattern>>,

git-cliff/src/lib.rs

@@ -129,7 +129,7 @@ pub fn run(mut args: Opt) -> Result<()> {
 		}
 	}
 	let commits =
-		repository.commits(commit_range, args.commit_path, args.exclude_path)?;
+		repository.commits(commit_range, args.include_path, args.exclude_path)?;
 
 	// Update tags.
 	if let Some(tag) = args.tag {