Changelog generation requires annotating commits with a commit type,
otherwise the tests will fail. This is annoying for contributors, since
it's unusual, and I often myself forget to do it, causing a round-trip
with tests.
So, skip generating the changelog during the tests. Also, change the
`--no-git` option for `gen book` and `gen all` to `--no-changelog`, so
it's clearer what it does.
I think I'll wind up just making a YAML file that contains commit types,
for changelog generation, so it doesn't have to be done in the commit
message.
type: testing
If both author name and email are present for a commit, format as a
link. If one is absent, format as the other. If both are absent, format
as "Anonymous".
type: documentation
Keybase and IRC chat never got any users, and since I never check them
and they get no traffic, it's probably best to remove them from the
readme.
type: documentation
- Add a `bench` feature that exposes a hasher benchmark.
- Make the hasher read up to the next piece end and hash everything it
reads, instead of hashing one byte at a time. This was a 4x
improvement on the benchmark. (Terrible code == easy wins!)
type: performance
To make it clearer what is and isn't generated content, make gen place
all generated output in `target/gen`.
Also, try to make the readme clearer about the location of build
artifacts.
type: development
- Document the various ways files can be included and excluded from
torrents in the book.
- Make links to the book more prominent in the readme, by including them
in sections with obvious names.
type: documentation
Don't commit man pages, since that bloats commits.
Attempt to build them in `bin/package`. This is fraught, since we need
`help2man`. Hopefully this works!
type: development
Committing the completion scripts bloats diffs, so stop committing them.
Before copying release files, generate the scripts in `bin/package`.
type: development
Unfortunately, the install script doesn't work on windows, due to:
- Powershell defining an alias that maps `curl` to `Invoke-WebRequest`,
which is incompatible with `curl`.
- The absence of the `rev` command.
type: documentation
fixes:
- https://github.com/casey/intermodal/issues/371
- Mention various chat channels
- Add `intermodal-bin` package to package table
- Document `bin/gen`
- Add contributing section
- Link to book
type: documentation
The command `--help` text output in the book was very wide, which caused
it to be clipped and require scrolling horizontally to see it all.
This diff renders the text at 80 columns, which makes it visible without
scrolling at reasonable screen sizes.
To do this, `env::run` now checks for the presence of the environment
variable `IMDL_TERM_WIDTH`, which, if set to a positive integer, will be
passed to `Clap::set_term_width`.
`bin/man` now uses this to render the help text at 80 characters.
type: documentation
pr: https://github.com/casey/intermodal/pull/364
Generates man pages and book entries for all subcommands, and keeps the
commands index in the book up to date.
There is much cursed roff munging in this diff.
type: documentation
This change Makes the changelog generator ignore fixup commits.
`git commit --fixup` can be used to mark that a commit should be
squashed before merging, which can be done automatically with
`git rebase --autosquash`. Fixup commits have a summary that starts with
`fixup!`
type: development
Torrents may now be created from standard input by passing `--input -`.
Since `--name` and `--output` cannot be deduced, they are required when
`--input -`.
type: added
Uses a crate in `bin/demo` to output a demo script of commands, with a
per-character and per-line delay, and a dummy prompt. Capture output
and render to a gif.
type: documentation
Shell completion scripts can be generated for `bash`, `elvish`, `fish`,
`powershell`, and `zsh` with the `completions` subcommand:
$ imdl completions --shell zsh > imdl.zsh
The same scripts are available in the `completions` directory. Please
refer to your shell's documentation for more information on how to
install and use completion scripts.
type: added
