intuit / intuit/auto

Improve documentation around `--dry-run --quiet` usage

Open
#1,889 0 comments 2 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
2.5k
Forks
221
PR merge metrics
No merged PRs in 30d

Description

Thanks for response, I'll be willing to contribute, but more so to the implementation of the command/flag than the docs about a "workaround" (from my perspective anyway). Let me explain my point of view and please, forgive me if I'm misinterpreting something, I'm very new to this tool and I really want to understand it and be able to use it.

These lines on the docs front page resonate very well with me:

> `auto` makes no assumptions about your publishing process. Each tool is a function that can be run in isolation and _only does one thing really well_. For instance, you could just use `auto changelog` to generate the changelog and nothing else or use `auto version` to calculate just the `semver` bump.

But then `changelog` doesn't actually just generate a changelog but also writes it to a file and commits it (which is 3 different things), and `shipit` is a combination of several different multi-step release processes that depends on the context.

I think all those things are useful, but when I read that paragraph I expected that there will be a set of simple commands that can be combined into any release process like building blocks. In that vein, when I saw the `version` command, I actually expected it to tell me _some version_ (current, last or next), not the _version bump_, just because it's called simply `version`, not `version-bump`.

Why does the next version come from a command that encompasses the _whole release process_? This seems counter-intuitive to me. Doesn't the current `version` command have enough information for calculating the next version?

_Originally posted by @laughedelic in https://github.com/intuit/auto/discussions/1867#discussioncomment-476814_

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.