Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tealdeer Maintainer Changes 2024 (And A Look Back) #376

Open
dbrgn opened this issue Aug 15, 2024 · 2 comments
Open

Tealdeer Maintainer Changes 2024 (And A Look Back) #376

dbrgn opened this issue Aug 15, 2024 · 2 comments

Comments

@dbrgn
Copy link
Collaborator

dbrgn commented Aug 15, 2024

A Look Back

deer-look-back

In December 2015, I made the first commit for tealdeer:

commit ba0283a1e7dbdec88fabc67bd49f1bdf3aca14d0
Author: Danilo Bargen <[email protected]>
Date:   Tue Dec 29 10:22:37 2015 +0100

    Initial version: Simply print content without formatting

Back then I randomly discovered the tldr project while browsing Hacker News. I was sitting in a train with 2 more hours of travel time to go, and thought that yet another tldr client would be a fun project to implement using Rust.

Fast forward 9 years, and tealdeer has become by far my most popular open source project on GitHub, with over 4k stars. (For comparison, the official NodeJS client has 430 stars and the official Python client has 590 stars.) Not only that, but it has also become part of the official package repositories of many major Linux distributions, including Arch Linux, Debian, Fedora and openSUSE.

Tealdeer was primarily a personal project of mine, where I wanted to experiment with a simple command line tool in Rust. The goal wasn't to support as many features as possible, it was being simple, fast, reliable and maintainable. However, the feature requests and pull requests started to pile up. Among them were many great ideas and contributions, and I'm thankful for the 64(!) individual contributors that have committed code for this project so far. But reviewing also takes a lot of time and energy.

Maintainer Changes

To help with reviews and maintenance, in late 2021 @niklasmohrin joined the project as co-maintainer. He has already helped a lot with keeping the project running and giving great constructive feedback to pull request submitters. But still, many pull requests were (and still are) open for a long time, usually waiting for my feedback. And while neither I nor Niklas owe anybody anything (free software is provided "as is" after all, without any responsibilities attached), I still wish for my open source projects to be welcoming and responsive for contributors, especially first-time contributors.

Recently I have gotten more responsibilities at work and will soon be getting more responsibilities at home. As such, I don't think I can give the project the attention anymore that it deserves. Luckily, @niklasmohrin has agreed to take over the project as primary maintainer, and I'm happy to be able to transfer the project ownership to him. Thank you for the work you did so far, and the work you'll keep doing!

What's Next?

The rough plan:

  • This repository will be transferred to a new GitHub organization called tealdeer-rs.
  • The release 1.7.0 will be tagged by me and published from the new organization. All project links will be updated.
  • @niklasmohrin will become the co-owner of the organization and the primary maintainer for tealdeer (including publish rights on crates.io).
  • I'll remain co-maintainer, but will only occasionally find time to contribute. I don't need to be involved in decisions anymore. Releases can be tagged and published without my involvement.

It may take a few weeks until this process is complete, thanks for your patience! And thanks again to all the people who contribute to this project, to keep making it better!

Danilo

@dbrgn dbrgn pinned this issue Aug 15, 2024
@kbdharun
Copy link
Contributor

Thanks for all your work with this wonderful repository. Good luck with your future endeavours.

@dbrgn
Copy link
Collaborator Author

dbrgn commented Oct 2, 2024

Organization transfer is done, and release 1.7.0 is out!

I think this is now done. I'll leave the issue open for visibility for a while, @niklasmohrin feel free to close once you feel like it 🙂

Goodbye, and thanks for all the fish! (I'll still be around occasionally though.)

tmeijn pushed a commit to tmeijn/dotfiles that referenced this issue 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 [#&#8203;376](tealdeer-rs/tealdeer#376).

Changes:

-   \[added] Allow querying multiple platforms (\[[#&#8203;300](tealdeer-rs/tealdeer#300)])
-   \[added] Add BSD platform support (\[[#&#8203;354](tealdeer-rs/tealdeer#354)])
-   \[added] Allow building with native-tls in addition to rustls (\[[#&#8203;303](tealdeer-rs/tealdeer#303)])
-   \[changed] Change custom page files to use a `.md` file extension (\[[#&#8203;322](tealdeer-rs/tealdeer#322)])
-   \[changed] Update to clap v4 for doing command line parsing (\[[#&#8203;298](tealdeer-rs/tealdeer#298)])
-   \[changed] Performance optimization in LineIterator (\[[#&#8203;314](tealdeer-rs/tealdeer#314)])
-   \[changed] Performance optimizations by tweaking Cargo flags (\[[#&#8203;355](tealdeer-rs/tealdeer#355)])
-   \[changed] Include completions in published crate (\[[#&#8203;333](tealdeer-rs/tealdeer#333)])
-   \[changed] Minimal supported Rust version is now 1.75 (\[[#&#8203;298](tealdeer-rs/tealdeer#298)])
-   \[fixed] Fix bash/zsh/fish completions when cache is empty (\[[#&#8203;327](tealdeer-rs/tealdeer#327)], \[[#&#8203;331](tealdeer-rs/tealdeer#331)])
-   \[docs] Publish docs only when tagging a release (\[[#&#8203;362](tealdeer-rs/tealdeer#362)])
-   \[docs] List Scoop and Debian packages (\[[#&#8203;305](tealdeer-rs/tealdeer#305)], \[[#&#8203;315](tealdeer-rs/tealdeer#315)])
-   \[docs] Add "Tips and Tricks" chapter to user manual (\[[#&#8203;342](tealdeer-rs/tealdeer#342)])
-   \[docs] Various docs improvements (\[[#&#8203;293](tealdeer-rs/tealdeer#293)])
-   \[chore] Improvements to CI workflows (\[[#&#8203;324](tealdeer-rs/tealdeer#324)])
-   \[chore] Update Cargo.toml license field following SPDX 2.1 (\[[#&#8203;336](tealdeer-rs/tealdeer#336)])
-   \[chore] Dependency updates

Contributors to this version:

-   \[Adam Henley]\[[@&#8203;adamazing](https://github.com/adamazing)]
-   \[Andrea Frigido]\[[@&#8203;frisoft](https://github.com/frisoft)]
-   \[Blair Noctis]\[[@&#8203;nc7s](https://github.com/nc7s)]
-   \[Danilo Bargen]\[[@&#8203;dbrgn](https://github.com/dbrgn)]
-   \[Felix Yan]\[[@&#8203;felixonmars](https://github.com/felixonmars)]
-   \[Iliia Maleki]\[[@&#8203;iliya-malecki](https://github.com/iliya-malecki)]
-   \[JJ Style]\[[@&#8203;jj-style](https://github.com/jj-style)]
-   \[K.B.Dharun Krishna]\[[@&#8203;kbdharun](https://github.com/kbdharun)]
-   \[Linus Walker]\[[@&#8203;Walker-00](https://github.com/Walker-00)]
-   \[Mohit Raj]\[[@&#8203;agrmohit](https://github.com/agrmohit)]
-   \[Nicolai Fröhlich]\[[@&#8203;nifr](https://github.com/nifr)]
-   \[Niklas Mohrin]\[[@&#8203;niklasmohrin](https://github.com/niklasmohrin)]
-   \[[@&#8203;qknogxxb](https://github.com/qknogxxb)]\[[@&#8203;qknogxxb](https://github.com/qknogxxb)]
-   \[[@&#8203;tveness](https://github.com/tveness)]\[[@&#8203;tveness](https://github.com/tveness)]
-   \[Y.D.X.]\[[@&#8203;YDX-2147483647](https://github.com/YDX-2147483647)]
-   \[Zacchary Dempsey-Plante]\[[@&#8203;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
Labels
None yet
Development

No branches or pull requests

2 participants