Tweak bb doc task that offers cljdoc previews #319
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The `doc` command has the same commands. Workflow remains: - `bb doc start` to start cljdoc docker image - while verifying, repeat: 1. make some edits 2. commit and push edits to branch 3. `bb doc ingest` to locally install jar and then ingest it into cljdoc 4. `bb doc view` to bring up docs in your browser (or if already open simply refresh them in browser) - when done: `bb doc stop` to stop cljdoc docker image Because polylith generates 2 artifacts the `ingest` and `view` commands optionally take `poly` (the default) or `api` as an extra arg. This effort was to get a preview flow working for polylith. We can address other issues, such as not documenting internal namespaces as a separate effort. Some details: - cleaned out unused gunk from `bb.edn`, wasn't sure if tasks other than `doc` are needed, so left them in. - added `install` and `version` commands to `build.clj` - switched to modern bb-isms in `cljdoc-preview.clj` - switched from nubank/docopt to babashka/cli - switched from babashka/curl to babashka/http-client - took advantage of newer babashka/fs functions - turfed all my script helpers
tengstrand
pushed a commit
that referenced
this pull request
Aug 8, 2023
The `doc` command has the same commands. Workflow remains: - `bb doc start` to start cljdoc docker image - while verifying, repeat: 1. make some edits 2. commit and push edits to branch 3. `bb doc ingest` to locally install jar and then ingest it into cljdoc 4. `bb doc view` to bring up docs in your browser (or if already open simply refresh them in browser) - when done: `bb doc stop` to stop cljdoc docker image Because polylith generates 2 artifacts the `ingest` and `view` commands optionally take `poly` (the default) or `api` as an extra arg. This effort was to get a preview flow working for polylith. We can address other issues, such as not documenting internal namespaces as a separate effort. Some details: - cleaned out unused gunk from `bb.edn`, wasn't sure if tasks other than `doc` are needed, so left them in. - added `install` and `version` commands to `build.clj` - switched to modern bb-isms in `cljdoc-preview.clj` - switched from nubank/docopt to babashka/cli - switched from babashka/curl to babashka/http-client - took advantage of newer babashka/fs functions - turfed all my script helpers
tengstrand
pushed a commit
that referenced
this pull request
Aug 22, 2023
The `doc` command has the same commands. Workflow remains: - `bb doc start` to start cljdoc docker image - while verifying, repeat: 1. make some edits 2. commit and push edits to branch 3. `bb doc ingest` to locally install jar and then ingest it into cljdoc 4. `bb doc view` to bring up docs in your browser (or if already open simply refresh them in browser) - when done: `bb doc stop` to stop cljdoc docker image Because polylith generates 2 artifacts the `ingest` and `view` commands optionally take `poly` (the default) or `api` as an extra arg. This effort was to get a preview flow working for polylith. We can address other issues, such as not documenting internal namespaces as a separate effort. Some details: - cleaned out unused gunk from `bb.edn`, wasn't sure if tasks other than `doc` are needed, so left them in. - added `install` and `version` commands to `build.clj` - switched to modern bb-isms in `cljdoc-preview.clj` - switched from nubank/docopt to babashka/cli - switched from babashka/curl to babashka/http-client - took advantage of newer babashka/fs functions - turfed all my script helpers
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The
doccommand has the same commands.Workflow remains:
bb doc startto start cljdoc docker imagebb doc ingestto locally install jar and then ingest it into cljdocbb doc viewto bring up docs in your browser (or if already open simply refresh them in browser)bb doc stopto stop cljdoc docker imageBecause polylith generates 2 artifacts the
ingestandviewcommands optionally takepoly(the default) orapias an extra arg.This effort was to get a preview flow working for polylith. We can address other issues, such as not documenting internal namespaces as a separate effort.
Some details:
bb.edn, wasn't sure if tasks other thandocare needed, so left them in.installandversioncommands tobuild.cljcljdoc-preview.clj