From 3c40c0c6eb91190ed2ab94c961de99dcbe3302ca Mon Sep 17 00:00:00 2001 From: Casey Rodarmor Date: Wed, 5 Jun 2024 21:17:05 +0200 Subject: [PATCH] Don't check in manpage (#2130) --- .github/workflows/release.yaml | 4 +- .gitignore | 1 + README.md | 1 - justfile | 1 + man/just.1 | 195 --------------------------------- 5 files changed, 5 insertions(+), 197 deletions(-) delete mode 100644 man/just.1 diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index f1ac72a3..0eb1953e 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -73,13 +73,15 @@ jobs: id: ref-type run: cargo run --package ref-type -- --reference ${{ github.ref }} >> $GITHUB_OUTPUT - - name: Generate Completion Scripts + - name: Generate Completion Scripts and Manpage run: | set -euxo pipefail cargo build for shell in bash elvish fish powershell zsh; do ./target/debug/just --completions $shell > completions/just.$shell done + mkdir -p man + ./target/debug/just -- --man > man/just.1 - name: Package id: package diff --git a/.gitignore b/.gitignore index ec381e40..443c5f02 100644 --- a/.gitignore +++ b/.gitignore @@ -10,6 +10,7 @@ /fuzz/artifacts /fuzz/corpus /fuzz/target +/man /target /test-utilities/Cargo.lock /test-utilities/target diff --git a/README.md b/README.md index aa48696e..6b05577a 100644 --- a/README.md +++ b/README.md @@ -3673,7 +3673,6 @@ Release x.y.z - Update changelog - Update changelog contributor credits - Update dependencies -- Update man page - Update version references in readme ``` diff --git a/justfile b/justfile index 6ad4dd82..e711cf94 100755 --- a/justfile +++ b/justfile @@ -43,6 +43,7 @@ shellcheck: shellcheck www/install.sh man: + mkdir -p man cargo run -- --man > man/just.1 view-man: man diff --git a/man/just.1 b/man/just.1 deleted file mode 100644 index 9f23943b..00000000 --- a/man/just.1 +++ /dev/null @@ -1,195 +0,0 @@ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.TH just 1 "just 1.27.0" -.SH NAME -just \- 🤖 Just a command runner \- https://github.com/casey/just -.SH SYNOPSIS -\fBjust\fR [\fB\-\-check\fR] [\fB\-\-chooser\fR] [\fB\-\-color\fR] [\fB\-\-command\-color\fR] [\fB\-\-yes\fR] [\fB\-n\fR|\fB\-\-dry\-run\fR] [\fB\-\-dump\-format\fR] [\fB\-\-highlight\fR] [\fB\-\-list\-heading\fR] [\fB\-\-list\-prefix\fR] [\fB\-\-no\-aliases\fR] [\fB\-\-no\-deps\fR] [\fB\-\-no\-dotenv\fR] [\fB\-\-no\-highlight\fR] [\fB\-f\fR|\fB\-\-justfile\fR] [\fB\-q\fR|\fB\-\-quiet\fR] [\fB\-\-set\fR] [\fB\-\-shell\fR] [\fB\-\-shell\-arg\fR] [\fB\-\-shell\-command\fR] [\fB\-\-clear\-shell\-args\fR] [\fB\-u\fR|\fB\-\-unsorted\fR] [\fB\-\-unstable\fR] [\fB\-v\fR|\fB\-\-verbose\fR]... [\fB\-d\fR|\fB\-\-working\-directory\fR] [\fB\-\-changelog\fR] [\fB\-\-choose\fR] [\fB\-c\fR|\fB\-\-command\fR] [\fB\-\-completions\fR] [\fB\-\-dump\fR] [\fB\-e\fR|\fB\-\-edit\fR] [\fB\-\-evaluate\fR] [\fB\-\-fmt\fR] [\fB\-\-init\fR] [\fB\-l\fR|\fB\-\-list\fR] [\fB\-\-groups\fR] [\fB\-\-man\fR] [\fB\-s\fR|\fB\-\-show\fR] [\fB\-\-summary\fR] [\fB\-\-variables\fR] [\fB\-\-dotenv\-filename\fR] [\fB\-E\fR|\fB\-\-dotenv\-path\fR] [\fB\-g\fR|\fB\-\-global\-justfile\fR] [\fB\-h\fR|\fB\-\-help\fR] [\fB\-V\fR|\fB\-\-version\fR] [\fIARGUMENTS\fR] -.SH DESCRIPTION -🤖 Just a command runner \- https://github.com/casey/just -.SH OPTIONS -.TP -\fB\-\-check\fR -Run `\-\-fmt` in \*(Aqcheck\*(Aq mode. Exits with 0 if justfile is formatted correctly. Exits with 1 and prints a diff if formatting is required. -.TP -\fB\-\-chooser\fR -Override binary invoked by `\-\-choose` -.RS -May also be specified with the \fBJUST_CHOOSER\fR environment variable. -.RE -.TP -\fB\-\-color\fR [default: auto] -Print colorful output -.br - -.br -[\fIpossible values: \fRauto, always, never] -.RS -May also be specified with the \fBJUST_COLOR\fR environment variable. -.RE -.TP -\fB\-\-command\-color\fR -Echo recipe lines in -.br - -.br -[\fIpossible values: \fRblack, blue, cyan, green, purple, red, yellow] -.RS -May also be specified with the \fBJUST_COMMAND_COLOR\fR environment variable. -.RE -.TP -\fB\-\-yes\fR -Automatically confirm all recipes. -.TP -\fB\-n\fR, \fB\-\-dry\-run\fR -Print what just would do without doing it -.RS -May also be specified with the \fBJUST_DRY_RUN\fR environment variable. -.RE -.TP -\fB\-\-dump\-format\fR=\fIFORMAT\fR [default: just] -Dump justfile as -.br - -.br -[\fIpossible values: \fRjust, json] -.TP -\fB\-\-highlight\fR -Highlight echoed recipe lines in bold -.TP -\fB\-\-list\-heading\fR=\fITEXT\fR -Print before list -.TP -\fB\-\-list\-prefix\fR=\fITEXT\fR -Print before each list item -.TP -\fB\-\-no\-aliases\fR -Don\*(Aqt show aliases in list -.TP -\fB\-\-no\-deps\fR -Don\*(Aqt run recipe dependencies -.TP -\fB\-\-no\-dotenv\fR -Don\*(Aqt load `.env` file -.TP -\fB\-\-no\-highlight\fR -Don\*(Aqt highlight echoed recipe lines in bold -.TP -\fB\-f\fR, \fB\-\-justfile\fR -Use as justfile -.RS -May also be specified with the \fBJUST_JUSTFILE\fR environment variable. -.RE -.TP -\fB\-q\fR, \fB\-\-quiet\fR -Suppress all output -.RS -May also be specified with the \fBJUST_QUIET\fR environment variable. -.RE -.TP -\fB\-\-set\fR=\fIVARIABLE VALUE\fR -Override with -.TP -\fB\-\-shell\fR -Invoke to run recipes -.TP -\fB\-\-shell\-arg\fR -Invoke shell with as an argument -.TP -\fB\-\-shell\-command\fR -Invoke with the shell used to run recipe lines and backticks -.TP -\fB\-\-clear\-shell\-args\fR -Clear shell arguments -.TP -\fB\-u\fR, \fB\-\-unsorted\fR -Return list and summary entries in source order -.TP -\fB\-\-unstable\fR -Enable unstable features -.RS -May also be specified with the \fBJUST_UNSTABLE\fR environment variable. -.RE -.TP -\fB\-v\fR, \fB\-\-verbose\fR -Use verbose output -.RS -May also be specified with the \fBJUST_VERBOSE\fR environment variable. -.RE -.TP -\fB\-d\fR, \fB\-\-working\-directory\fR -Use as working directory. \-\-justfile must also be set -.RS -May also be specified with the \fBJUST_WORKING_DIRECTORY\fR environment variable. -.RE -.TP -\fB\-\-changelog\fR -Print changelog -.TP -\fB\-\-choose\fR -Select one or more recipes to run using a binary chooser. If `\-\-chooser` is not passed the chooser defaults to the value of $JUST_CHOOSER, falling back to `fzf` -.TP -\fB\-c\fR, \fB\-\-command\fR -Run an arbitrary command with the working directory, `.env`, overrides, and exports set -.TP -\fB\-\-completions\fR=\fISHELL\fR -Print shell completion script for -.br - -.br -[\fIpossible values: \fRbash, elvish, fish, powershell, zsh] -.TP -\fB\-\-dump\fR -Print justfile -.TP -\fB\-e\fR, \fB\-\-edit\fR -Edit justfile with editor given by $VISUAL or $EDITOR, falling back to `vim` -.TP -\fB\-\-evaluate\fR -Evaluate and print all variables. If a variable name is given as an argument, only print that variable\*(Aqs value. -.TP -\fB\-\-fmt\fR -Format and overwrite justfile -.TP -\fB\-\-init\fR -Initialize new justfile in project root -.TP -\fB\-l\fR, \fB\-\-list\fR -List available recipes and their arguments -.TP -\fB\-\-groups\fR -List recipe groups -.TP -\fB\-\-man\fR -Print man page -.TP -\fB\-s\fR, \fB\-\-show\fR=\fIRECIPE\fR -Show information about -.TP -\fB\-\-summary\fR -List names of available recipes -.TP -\fB\-\-variables\fR -List names of variables -.TP -\fB\-\-dotenv\-filename\fR -Search for environment file named instead of `.env` -.TP -\fB\-E\fR, \fB\-\-dotenv\-path\fR -Load as environment file instead of searching for one -.TP -\fB\-g\fR, \fB\-\-global\-justfile\fR -Use global justfile -.TP -\fB\-h\fR, \fB\-\-help\fR -Print help -.TP -\fB\-V\fR, \fB\-\-version\fR -Print version -.TP -[\fIARGUMENTS\fR] -Overrides and recipe(s) to run, defaulting to the first recipe in the justfile -.SH VERSION -v1.27.0 -.SH AUTHORS -Casey Rodarmor