Generate docs only upon release #362
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
Signed-off-by: Adam Henley <adamazing@gmail.com>
tmeijn
pushed a commit
to tmeijn/dotfiles
that referenced
this pull request
Oct 16, 2024
This MR contains the following updates: | Package | Update | Change | |---|---|---| | [dbrgn/tealdeer](https://github.com/dbrgn/tealdeer) | minor | `v1.6.1` -> `v1.7.0` | MR created with the help of [el-capitano/tools/renovate-bot](https://gitlab.com/el-capitano/tools/renovate-bot). **Proposed changes to behavior should be submitted there as MRs.** --- ### Release Notes <details> <summary>dbrgn/tealdeer (dbrgn/tealdeer)</summary> ### [`v1.7.0`](https://github.com/dbrgn/tealdeer/blob/HEAD/CHANGELOG.md#v170-v170-2024-10-02) [Compare Source](tealdeer-rs/tealdeer@v1.6.1...v1.7.0) It's been 24 months since the last release, time for tealdeer 1.7.0! Thanks to 16 individual contributors, a few nice changes and features are included in this release. One change is that you can **query multiple platforms at once**. For example: tldr --platform openbsd --platform linux df This will show the `df` page for OpenBSD (if available), followed by Linux (if available), with fallback to the current platform on which tealdeer runs. What's that `openbsd` thing up there? Yes, there's now **support for the BSD platforms `freebsd`, `netbsd` and `openbsd`**. And since we're already talking about platform support: Our **binary releases now include builds for ARM64 (aka `aarch64`) on macOS (Apple Silicon, M1/M2/M3) and Linux**. *(Keep in mind that binary releases are generated in CI and are unsigned. For a trusted build, please compile from source.)* There's also a breaking change for the folks using [custom pages and patches](https://tealdeer-rs.github.io/tealdeer/usage_custom_pages.html): These files now use a `.md` extension. Old files will continue to work, but will result a deprecation warning being printed when used. On a personal note, this will be the last release from me ([Danilo](https://github.com/dbrgn/)) as primary maintainer of tealdeer. For details, see [#​376](tealdeer-rs/tealdeer#376). Changes: - \[added] Allow querying multiple platforms (\[[#​300](tealdeer-rs/tealdeer#300)]) - \[added] Add BSD platform support (\[[#​354](tealdeer-rs/tealdeer#354)]) - \[added] Allow building with native-tls in addition to rustls (\[[#​303](tealdeer-rs/tealdeer#303)]) - \[changed] Change custom page files to use a `.md` file extension (\[[#​322](tealdeer-rs/tealdeer#322)]) - \[changed] Update to clap v4 for doing command line parsing (\[[#​298](tealdeer-rs/tealdeer#298)]) - \[changed] Performance optimization in LineIterator (\[[#​314](tealdeer-rs/tealdeer#314)]) - \[changed] Performance optimizations by tweaking Cargo flags (\[[#​355](tealdeer-rs/tealdeer#355)]) - \[changed] Include completions in published crate (\[[#​333](tealdeer-rs/tealdeer#333)]) - \[changed] Minimal supported Rust version is now 1.75 (\[[#​298](tealdeer-rs/tealdeer#298)]) - \[fixed] Fix bash/zsh/fish completions when cache is empty (\[[#​327](tealdeer-rs/tealdeer#327)], \[[#​331](tealdeer-rs/tealdeer#331)]) - \[docs] Publish docs only when tagging a release (\[[#​362](tealdeer-rs/tealdeer#362)]) - \[docs] List Scoop and Debian packages (\[[#​305](tealdeer-rs/tealdeer#305)], \[[#​315](tealdeer-rs/tealdeer#315)]) - \[docs] Add "Tips and Tricks" chapter to user manual (\[[#​342](tealdeer-rs/tealdeer#342)]) - \[docs] Various docs improvements (\[[#​293](tealdeer-rs/tealdeer#293)]) - \[chore] Improvements to CI workflows (\[[#​324](tealdeer-rs/tealdeer#324)]) - \[chore] Update Cargo.toml license field following SPDX 2.1 (\[[#​336](tealdeer-rs/tealdeer#336)]) - \[chore] Dependency updates Contributors to this version: - \[Adam Henley]\[[@​adamazing](https://github.com/adamazing)] - \[Andrea Frigido]\[[@​frisoft](https://github.com/frisoft)] - \[Blair Noctis]\[[@​nc7s](https://github.com/nc7s)] - \[Danilo Bargen]\[[@​dbrgn](https://github.com/dbrgn)] - \[Felix Yan]\[[@​felixonmars](https://github.com/felixonmars)] - \[Iliia Maleki]\[[@​iliya-malecki](https://github.com/iliya-malecki)] - \[JJ Style]\[[@​jj-style](https://github.com/jj-style)] - \[K.B.Dharun Krishna]\[[@​kbdharun](https://github.com/kbdharun)] - \[Linus Walker]\[[@​Walker-00](https://github.com/Walker-00)] - \[Mohit Raj]\[[@​agrmohit](https://github.com/agrmohit)] - \[Nicolai Fröhlich]\[[@​nifr](https://github.com/nifr)] - \[Niklas Mohrin]\[[@​niklasmohrin](https://github.com/niklasmohrin)] - \[[@​qknogxxb](https://github.com/qknogxxb)]\[[@​qknogxxb](https://github.com/qknogxxb)] - \[[@​tveness](https://github.com/tveness)]\[[@​tveness](https://github.com/tveness)] - \[Y.D.X.]\[[@​YDX-2147483647](https://github.com/YDX-2147483647)] - \[Zacchary Dempsey-Plante]\[[@​zedseven](https://github.com/zedseven)] Thanks! </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this MR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this MR, check this box --- This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy40NDAuNyIsInVwZGF0ZWRJblZlciI6IjM3LjQ0MC43IiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6WyJSZW5vdmF0ZSBCb3QiXX0=-->
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.
Small PR to implement the stop-gap solution discussed in Issue #358 (#358 (comment))
Makes the gh-pages workflow run only on version tag push (i.e. release).