Skip to content

Commit

Permalink
Rel path updates (#39)
Browse files Browse the repository at this point in the history
* link apis to table of contents

* readme link

* argmap and doc updates

* abs path cleanup

* clippy
  • Loading branch information
pnordahl authored Dec 1, 2024
1 parent ebdb4a0 commit a8c8ae6
Show file tree
Hide file tree
Showing 13 changed files with 415 additions and 442 deletions.
10 changes: 9 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
# Change Log

## [3.6.0] - 2024-12-01

### Changed
- Replaced `--argmap` JSON literals with `--argmaps`, which accepts a list of argmap names to load
- Replaced `--arg` with `--args` for consistency with other option pluralization
- Removed `--argmap-file` direct loading in favor of `--argmaps`
- Changed target `argmaps` configuration to align with new autoloading API
- Replaced `is_executable` boolean in `target show --commands` to `permissions` showing octal mode

## [3.5.7] - 2024-11-26

### Fixed
Expand Down Expand Up @@ -56,7 +65,6 @@
## [3.5.0] - 2024-11-13

### Changed
- `--arg, --arg-map, and --arg-map` are now `--target-argmap, and --target-argmap`
- Default commands directory from `monorail` to `monorail/cmd`

### Added
Expand Down
71 changes: 32 additions & 39 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

18 changes: 9 additions & 9 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,21 @@ description = "A tool for effective polyglot, multi-project monorepo development
license = "MIT"
homepage = "https://github.com/pnordahl/monorail"
repository = "https://github.com/pnordahl/monorail"
version = "3.5.7"
version = "3.6.0"
authors = ["Patrick Nordahl <[email protected]>"]
edition = "2021"
keywords = ["monorail", "monorepo", "build", "cli", "build-tool"]
resolver = "2"

[dependencies]
clap = "4.5"
serde = { version = "1.0", features = ["derive"] }
serde_json = { version = "1.0", features = ["std"] }
trie-rs = "0.4"
tokio = { version = "1.40", features = ["net", "fs", "io-std", "io-util", "process", "rt", "macros", "rt-multi-thread", "sync"] }
tokio-util = { version = "0.7" }
clap = "4.5.21"
serde = { version = "1.0.215", features = ["derive"] }
serde_json = { version = "1.0.133", features = ["std"] }
trie-rs = "0.4.2"
tokio = { version = "1.41.1", features = ["net", "fs", "io-std", "io-util", "process", "rt", "macros", "rt-multi-thread", "sync"] }
tokio-util = { version = "0.7.12" }
tokio-stream = "0.1.16"
sha2 = "0.10"
sha2 = "0.10.8"
zstd = "0.13.2"
tracing = { version = "0.1.40", features = ["attributes"] }
tracing-subscriber = { version = "0.3.18", features = ["time", "fmt", "std", "registry", "json", "env-filter"] }
Expand All @@ -27,4 +27,4 @@ chrono = { version = "0.4.38", default-features = false, features = ["alloc", "n
rayon = "1.10.0"

[dev-dependencies]
tempfile = "3.13"
tempfile = "3.14.0"
33 changes: 19 additions & 14 deletions Monorail.reference.js
Original file line number Diff line number Diff line change
Expand Up @@ -88,21 +88,26 @@ const reference = {
"argmaps": {
/*
Default location within this target path containing argmap
definition files. This is used when locating argmaps for this
target automatically when it is changed.
definition files. This is used when locating argmaps when
no definition path for that argmap is specified.
Optional, default: "monorail/argmap"
Optional, default: "path/to/target/monorail/argmap"
*/
"path": "path/within/this/target",
"path": "path/within/repository",

/*
Path to the default argmap to load for this target. This argmap
is loaded prior to any arguments supplied by use of
--arg, --target-argmap, and --target-argmap-file switches on `monorail run`.
Overrides for this targets argmaps.
Optional, default: "base.json"
Optional, default: {}
*/
"base": "path/within/target/argmaps/path"
"definitions": {
"<argmap name>": {
// Path to a JSON file to use for this argmap.
// Required, if the parent key is specified.
// Default: <argmaps.path>/<argmap name>.json
"path": "path/within/repository"
}
}
}


Expand All @@ -116,20 +121,20 @@ const reference = {
executables. This is used when locating executables for a
command when no definition path for that command is specified.
Optional, default: "monorail/cmd"
Optional, default: "path/to/target/monorail/cmd"
*/
"path": "path/within/this/target"
"path": "path/within/repository"

/*
Overrides for this targets command executables and
their arguments.
Overrides for this targets command executables.
Optional, default: {}
*/
"definitions": {
"<command_name>": {
// Path to an executable to use for this command.
// Optional. default: <commands.path>/<command_name>.<extension>,
// Required, if the parent key is specified.
// Default: <commands.path>/<command_name>.<extension>,
// where <extension> is discovered on the filesystem.
"path": "path/within/repository"
}
Expand Down
Loading

0 comments on commit a8c8ae6

Please sign in to comment.