feat: add BSD platform support; chore: update workflows #354

kbdharun · 2024-02-20T17:24:23Z

Changes

This PR adds support for FreeBSD, NetBSD and OpenBSD platforms that we recently added upstream (I announced it as part of the 2.1 client specification release last year).
~~This PR also adds support for querying the common platform via a dedicated flag for Allow passing common as platform #323.~~ (This didn't work during testing so will revert it)
Bump actions from v3 (Node 16) to v4 (Node 20).
Added GitHub dependabot configuration to automate these dependency updates for GitHub actions as well as Cargo (dependabot will create PRs monthly to update these dependencies).
Fix spacing in the changelog.

For #349

Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>

This reverts commit 015b01f.

niklasmohrin

Thanks!

Not sure how I feel about dependabot for cargo, especially in regard to keeping a minimum supported Rust version (MSRV), but we can add the change and see how it goes. What do you think? @dbrgn

dbrgn · 2024-03-03T20:30:06Z

I agree with @niklasmohrin. The "github-actions" dependabot check is great, but for Cargo we already get dependabot PRs for security issues. For regular updates, I'd prefer to do those manually, so it would be nice if you could remove the package-ecosystem: "cargo" config.

CHANGELOG.md

dbrgn · 2024-03-03T20:31:40Z

.github/workflows/release.yml

      - name: Setup toolchain
        uses: dtolnay/rust-toolchain@master
        with:
          toolchain: stable
      - name: Build
        run: cargo build --release --target x86_64-apple-darwin --no-default-features --features webpki-roots
-      - uses: actions/upload-artifact@v3


Did you check the changelog of these actions (this one, and also download-artifact below), to ensure that there were no breaking changes?

(Since these actions are part of the release workflow, they don't run on regular testing CI runs.)

Did you check the changelog of these actions (this one, and also download-artifact below), to ensure that there were no breaking changes?

Yes, I checked both the action's changelog's there seem to be no breaking changes.

I tested this now in my fork at https://github.com/kbdharun/tealdeer/actions/runs/8148684799 (ignore the failing one that's because I chose a rogue tag, build jobs work fine).

adamazing · 2024-04-10T05:36:36Z

If this PR is close to merging and it doesn't hold it back, maybe the change to run the gh-pages action only on release tags could be done here?

If you want to keep it separate I can do a quick PR to do that if it would help?

Re: #358 (comment)

niklasmohrin · 2024-04-10T07:09:05Z

Lets do it separately

niklasmohrin · 2024-04-10T07:10:16Z

If you want to avoid the conflicts, I can merge this in the next couple of days

src/types.rs

Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>

niklasmohrin · 2024-04-10T14:05:57Z

Thanks!

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. --- - [ ] If you want to rebase/retry this MR, check this box --- This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).

kbdharun added 4 commits February 20, 2024 22:50

feat: add BSD platform support; chore: update workflows

820d65f

Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>

fix: formatiing of types.rs

06b3e7a

Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>

feat: add support for common platform flag

015b01f

Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>

Revert "feat: add support for common platform flag"

2eda13f

This reverts commit 015b01f.

niklasmohrin approved these changes Mar 1, 2024

View reviewed changes

dbrgn reviewed Mar 3, 2024

View reviewed changes

kbdharun added 2 commits March 5, 2024 05:19

revert: changes to CHANGELOG.md

14c92c2

cleanup: remove cargo updates from dependabot

f2330bd

kbdharun requested a review from dbrgn March 4, 2024 23:50

Merge branch 'dbrgn:main' into main

06dfef2

niklasmohrin reviewed Apr 10, 2024

View reviewed changes

src/types.rs Outdated Show resolved Hide resolved

niklasmohrin reviewed Apr 10, 2024

View reviewed changes

src/types.rs Outdated Show resolved Hide resolved

types.rs: update file

d7d97c1

Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>

kbdharun marked this pull request as draft April 10, 2024 13:53

fix: update Bsd case convention

fdca132

Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>

kbdharun marked this pull request as ready for review April 10, 2024 13:56

kbdharun requested a review from niklasmohrin April 10, 2024 13:56

niklasmohrin approved these changes Apr 10, 2024

View reviewed changes

niklasmohrin merged commit ee6d241 into tealdeer-rs:main Apr 10, 2024
9 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add BSD platform support; chore: update workflows #354

feat: add BSD platform support; chore: update workflows #354

kbdharun commented Feb 20, 2024 •

edited

Loading

niklasmohrin left a comment

dbrgn commented Mar 3, 2024

dbrgn Mar 3, 2024

kbdharun Mar 4, 2024 •

edited

Loading

adamazing commented Apr 10, 2024

niklasmohrin commented Apr 10, 2024

niklasmohrin commented Apr 10, 2024

niklasmohrin commented Apr 10, 2024

feat: add BSD platform support; chore: update workflows #354

feat: add BSD platform support; chore: update workflows #354

Conversation

kbdharun commented Feb 20, 2024 • edited Loading

Changes

niklasmohrin left a comment

Choose a reason for hiding this comment

dbrgn commented Mar 3, 2024

dbrgn Mar 3, 2024

Choose a reason for hiding this comment

kbdharun Mar 4, 2024 • edited Loading

Choose a reason for hiding this comment

adamazing commented Apr 10, 2024

niklasmohrin commented Apr 10, 2024

niklasmohrin commented Apr 10, 2024

niklasmohrin commented Apr 10, 2024

kbdharun commented Feb 20, 2024 •

edited

Loading

kbdharun Mar 4, 2024 •

edited

Loading