09 05 updates

CHANGELOG.md

@@ -1,4 +1,12 @@
 # Change Log
+
+## [2.1.0] - 2024-09-05
+
+### Changed
+
+- '-d' working directory flag changed to '-w'
+- Delete local git tag when a checkpoint fails to push
+- Changed checkpoint id format from incrementing semver to incrementing `monorail-N`, N > 0
 
 ## [2.0.0] - 2024-09-03
 

Cargo.toml

@@ -1,10 +1,10 @@
 [package]
 name = "monorail"
-description = "A monorepo overlay for version control systems."
+description = "A monorepo overlay."
 license = "MIT"
 homepage = "https://github.com/pnordahl/monorail"
 repository = "https://github.com/pnordahl/monorail"
-version = "2.0.0"
+version = "2.1.0"
 authors = ["Patrick Nordahl <[email protected]>"]
 edition = "2021"
 keywords = ["monorail", "monorepo"]

README.md

@@ -45,7 +45,7 @@ Monorail has a simple lexicon:
 
 `monorail` works by labeling filesystem paths within a repository as meaningful. These labels determine how changes reported by the vcs are interpreted. The label types are:
 
-* target: A unique container that can be referenced by change detection and script execution. For example, `ui`, `api`, and `database`, as directories carrying files specific to those projects, would be good candidates for being labeled as targets. So too would a parent directory like `apps`, because targets are _recursive_, which means that targets can lie within the path of other targets.
+* target: A unique container that can be referenced by change detection and script execution. For example, `ui`, `api`, and `database`, as directories carrying files specific to those projects, would be good candidates for being labeled as targets. You can also label directories containing multiple targets as a target (e.g. `apps` containing your projects).
 * links: A set of paths that recursively affect a target and any targets that lie in its path. For example, a `vendor` directory carrying copies of third-party code may require that all targets within a target's path subdirectories be re-tested.
 * uses: A set of paths that affect a target. For example, a directory called `common`, carrying files used by multiple targets might be referred to by multiple targets in their `uses` arrays.
 * ignores: a set of paths that do not affect a target
@@ -59,7 +59,7 @@ For executing code against targets, two more terms:
 
 _NOTE: this tutorial assumes a UNIX-like environment._
 
-In this tutorial, you'll learn:
+In this tutorial, you'll learn about:
 
   * mapping repository paths to targets
   * analyzing
@@ -114,7 +114,7 @@ _NOTE_: All filesystem locations specified in `Monorail.toml` are relative to th
 
 ## Analyzing changes
 
-`monorail` will detect changes since the last checkpoint; see: [Checkpointing](##Checkpointing). For `git`, this means uncommitted, committed, and pushed files since the last annotated tag created by `monorail checkpoint create`.
+`monorail` will detect changes since the last checkpoint; see: [Checkpointing](#checkpointing). For `git`, this means uncommitted, committed, and pushed files since the last annotated tag created by `monorail checkpoint create`.
 
 ### Analyze showing no affected targets
 
@@ -223,7 +223,7 @@ Push, and view changes again:
 git push && monorail analyze | jq .
 ```
 
-As with the commit, `monorail` still knows about the changes after a push. The reason for this will be explained in the section on checkpointing below.
+As with the commit, `monorail` still knows about the changes after a push. The reason for this will be explained in the section on [Checkpointing](#checkpointing) below.
 
 ## Declaring "uses" and "links"
 
@@ -647,7 +647,7 @@ monorail checkpoint create --dry-run -t patch | jq .
 
 ```json
 {
-  "id": "v0.0.1",
+  "id": "monorail-1",
   "targets": [
     "group1/Lockfile",
     "group1/common/library1",
@@ -669,7 +669,7 @@ monorail checkpoint create -t patch | jq .
 
 ```json
 {
-  "id": "v0.0.1",
+  "id": "monorail-1",
   "targets": [
     "group1/Lockfile",
     "group1/common/library1",
@@ -696,13 +696,13 @@ monorail analyze | jq .
 Finally, our newly-pushed tag is now in the remote. To see this, execute:
 
 ```sh
-git -C ../monorail-tutorial-remote show -s --format=%B v0.0.1
+git -C ../monorail-tutorial-remote show -s --format=%B monorail-1
 ```
 
 ... which outputs
 
 ```
-tag v0.0.1
+tag monorail-1
 Tagger: John Doe <[email protected]>
 
 rust

ext/bash/monorail-bash.sh

@@ -18,7 +18,7 @@ function print_help {
 	echo ""
 	echo "    -h               Display this help message."
 	echo "    -f <file>        The monorail configuration file to use. Default: Monorail.toml"
-	echo "    -d <path>        The directory to run commands from. Default: current directory"
+	echo "    -w <path>        The directory to run commands from. Default: current directory"
 	echo "    -v               Print extra information."
 	echo ""
 	echo "Subcommands:"
@@ -69,7 +69,7 @@ function process_exec {
 	fi
 
 	# build array of args to pass to monorail
-	monorail_args=("-f" "$config_file" "-d" "$working_directory")
+	monorail_args=("-f" "$config_file" "-w" "$working_directory")
 
 	if [ ${#commands[@]} -eq 0 ]; then
 	    log_error "error: no commands specified"
@@ -172,7 +172,7 @@ function execute_target_command {
 	local target=$2
 	local script=$3
 	pushd "$working_directory" > /dev/null || return
-	if [ ! -d "$target" ]; then
+	if [ ! -w "$target" ]; then
 		log_verbose  "$(printf "NOTE: Ignoring command for non-directory target; command: %s, target: %s" "$command" "$target")"
 		popd > /dev/null || return
 		return
@@ -199,7 +199,7 @@ function execute_target_command {
 }
 
 # parse options to `monorail-bash`
-while getopts "f:d:hv" opt; do
+while getopts "f:w:hv" opt; do
 	case "$opt" in
 		h )
 			print_help
@@ -208,7 +208,7 @@ while getopts "f:d:hv" opt; do
 		f )
 			config_file=$OPTARG
 			;;
-		d )
+		w )
 			working_directory=$OPTARG
 			;;
 		v )

src/bin/monorail.rs

@@ -32,7 +32,7 @@ fn get_app() -> clap::Command {
     )
     .arg(
         Arg::new("working-directory")
-            .short('d')
+            .short('w')
             .long("working-directory")
             .help("Sets a directory to use for execution")
             .num_args(1),
@@ -49,29 +49,19 @@ fn get_app() -> clap::Command {
     .subcommand(Command::new("config").about("Show configuration, including runtime default values"))
     .subcommand(Command::new("checkpoint")
         .subcommand(
-            Command::new("create")
-                .about("Create a checkpoint of current changes")
-                .after_help(r#"This command analyzes changed targets since the last checkpoint, constructs a checkpoint object appropriate for the configured vcs"#)
-                .arg(arg_git_path.clone())
-                .arg(arg_use_libgit2_status.clone())
-                .arg(
-                    Arg::new("type")
-                        .short('t')
-                        .long("type")
-                        .help("Semver component to increment for this checkpoint")
-                        .value_parser(["patch", "minor", "major"])
-                        .ignore_case(true)
-                        .required(true)
-                        .num_args(1),
-                )
-                .arg(
-                    Arg::new("dry-run")
-                        .short('d')
-                        .long("dry-run")
-                        .help("Do not apply any changes locally (for a distributed version control system) or remotely")
-                        .action(ArgAction::SetTrue),
-                ))
-    )
+        Command::new("create")
+            .about("Create a checkpoint of current changes")
+            .after_help(r#"This command analyzes changed targets since the last checkpoint, constructs a checkpoint object appropriate for the configured vcs"#)
+            .arg(arg_git_path.clone())
+            .arg(arg_use_libgit2_status.clone())
+            .arg(
+                Arg::new("dry-run")
+                    .short('d')
+                    .long("dry-run")
+                    .help("Do not apply any changes locally (for a distributed version control system) or remotely")
+                    .action(ArgAction::SetTrue),
+            )
+    ))
     .subcommand(
         Command::new("analyze")
             .about("Analyze repository changes and targets")