Skip to content

Commit

Permalink
chore: increase version
Browse files Browse the repository at this point in the history
  • Loading branch information
kbknapp committed Nov 27, 2017
1 parent 6f4c341 commit 9ef3d82
Show file tree
Hide file tree
Showing 3 changed files with 54 additions and 32 deletions.
34 changes: 34 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,37 @@
<a name="2.28.0"></a>
## 2.28.0 (2017-11-27)

The minimum required Rust is now 1.20. This was done to start using bitflags 1.0 and having >1.0 deps is a *very good* thing!


#### API Additions

* Adds the traits to be used with the `clap-derive` crate to be able to use Custom Derive ([6f4c3412](https://github.com/kbknapp/clap-rs/commit/6f4c3412415e882f5ca2cc3fbd6d4dce79440828))

#### Improvements

* adds '[SUBCOMMAND]' to usage strings with only AppSettings::AllowExternalSubcommands is used with no other subcommands ([e78bb757](https://github.com/kbknapp/clap-rs/commit/e78bb757a3df16e82d539e450c06767a6bfcf859), closes [#1093](https://github.com/kbknapp/clap-rs/issues/1093))
* uses `.bash` for Bash completion scripts now instead of `.bash-completion` due to convention and `.bash-completion` not being supported by completion projects ([4740cde4](https://github.com/kbknapp/clap-rs/commit/4740cde404121a443c64d644eb4a0722c0b0a823)

#### Documentation

* Fix URL path to github hosted files ([ce72aada](https://github.com/kbknapp/clap-rs/commit/ce72aada56a9581d4a6cb4bf9bdb861c3906f8df), closes [#1106](https://github.com/kbknapp/clap-rs/issues/1106))
* fix typo ([002b07fc](https://github.com/kbknapp/clap-rs/commit/002b07fc98a1c85acb66296b1eec0b2aba906125))
* **README.md:** updates the readme and pulls out some redundant sections ([db6caf86](https://github.com/kbknapp/clap-rs/commit/db6caf8663747e679d2f4ed3bd127f33476754aa))

#### Bug Fixes

* Fixes a regression where --help couldn't be overridden ([a283d69f](https://github.com/kbknapp/clap-rs/commit/a283d69fc08aa016ae1bf9ba010012abecc7ba69), closes [#1112](https://github.com/kbknapp/clap-rs/issues/1112))
* fixes a bug that allowed options to pass parsing when no value was provided ([2fb75821](https://github.com/kbknapp/clap-rs/commit/2fb758219c7a60d639da67692e100b855a8165ac), closes [#1105](https://github.com/kbknapp/clap-rs/issues/1105))
* ignore PropagateGlobalValuesDown deprecation warning ([f61ce3f5](https://github.com/kbknapp/clap-rs/commit/f61ce3f55fe65e16b3db0bd4facdc4575de22767), closes [#1086](https://github.com/kbknapp/clap-rs/issues/1086))


#### Deps

* Updates `bitflags` to 1.0



<a name="v2.27.1"></a>
## v2.27.1 (2017-10-24)

Expand Down
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[package]

name = "clap"
version = "2.27.2"
version = "2.28.0"
authors = ["Kevin K. <kbknapp@gmail.com>"]
exclude = ["examples/*", "clap-test/*", "tests/*", "benches/*", "*.png", "clap-perf/*", "*.dot"]
repository = "https://github.com/kbknapp/clap-rs"
Expand Down
50 changes: 19 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,33 +42,20 @@ Created by [gh-md-toc](https://github.com/ekalinin/github-markdown-toc)

## What's New

Here's whats new in 2.27.1:

** This release also contains a very minor breaking change to fix a bug **

The only CLIs affected will be those using unrestrained multiple values and subcommands where the
subcommand name can coincide with one of the multiple values.

See the commit [0c223f54](https://github.com/kbknapp/clap-rs/commit/0c223f54ed46da406bc8b43a5806e0b227863b31) for full details.

* Adds `term_size` as an optional dependency (with feature `wrap_help`) to fix compile bug
* **The minimum required version of Rust is now 1.18.0 (Stable)**
* Values from global args are now propagated UP and DOWN!
* fixes a bug where using AppSettings::AllowHyphenValues would allow invalid arguments even when there is no way for them to be valid
* when an argument requires a value and that value happens to match a subcommand name, its parsed as a value
* fixes a bug that prevented number_of_values and default_values to be used together
* fixes a bug that didn't allow args with default values to have conflicts
* fixes a panic when using global args and calling App::get_matches_from_safe_borrow multiple times
* fixes issues and potential regressions with global args values not being propagated properly or at all
* fixes a bug where default values are not applied if the option supports zero values
* adds addtional blurbs about using multiples with subcommands
* updates the docs to reflect changes to global args and that global args values can now be propagated back up the stack
* add html_root_url attribute
* sync README version numbers with crate version
* args that have require_delimiter(true) is now reflected in help and usage strings
* if all subcommands are hidden, the subcommands section of the help message is no longer displayed
* fixes when an argument requires a value and that value happens to match a subcommand name, its parsed as a value
* **AppSettings::PropagateGlobalValuesDown:** this setting deprecated and is no longer required to propagate values down or up
Here's whats new in 2.28.0:

The minimum required Rust is now 1.20. This was done to start using bitflags 1.0 and having >1.0 deps is a *very good* thing!

* Updates `bitflags` to 1.0
* Adds the traits to be used with the `clap-derive` crate to be able to use Custom Derive (for now must be accessed with `unstable` feature flag)
* Fixes a regression where --help couldn't be overridden
* adds '[SUBCOMMAND]' to usage strings with only AppSettings::AllowExternalSubcommands is used with no other subcommands
* uses `.bash` for Bash completion scripts now instead of `.bash-completion` due to convention and `.bash-completion` not being supported by completion projects
* Fix URL path to github hosted files
* fix typos in docs
* **README.md:** updates the readme and pulls out some redundant sections
* fixes a bug that allowed options to pass parsing when no value was provided
* ignore PropagateGlobalValuesDown deprecation warning

For full details, see [CHANGELOG.md](https://github.com/kbknapp/clap-rs/blob/master/CHANGELOG.md)

Expand Down Expand Up @@ -390,12 +377,13 @@ SUBCOMMANDS:

### Pre-Built Test

To try out the pre-built example, use the following steps:
To try out the pre-built examples, use the following steps:

* Clone the repository `$ git clone https://github.com/kbknapp/clap-rs && cd clap-rs/tests`
* Compile the example `$ cargo build --release`
* Run the help info `$ ./target/release/claptests --help`
* Clone the repository `$ git clone https://github.com/kbknapp/clap-rs && cd clap-rs/`
* Compile the example `$ cargo build --example <EXAMPLE>`
* Run the help info `$ ./target/debug/examples/<EXAMPLE> --help`
* Play with the arguments!
* You can also do a onetime run via `$ cargo run --example <EXAMPLE> -- [args to example]

### BYOB (Build Your Own Binary)

Expand Down

0 comments on commit 9ef3d82

Please sign in to comment.