Skip to content

Commit d682fde

Browse files
committed
feat: update files for new release
Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
1 parent 775f47d commit d682fde

File tree

4 files changed

+35
-13
lines changed

4 files changed

+35
-13
lines changed

.github/workflows/test.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ jobs:
147147
os: ['ubuntu-latest', 'ubuntu-24.04-arm']
148148

149149
steps:
150-
- uses: actions/checkout@v4
150+
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
151151

152152
- uses: canonical/action-build@3bdaa03e1ba6bf59a65f84a751d943d549a54e79 # v1.3.0
153153
id: snapcraft-build

CHANGELOG.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,29 @@
11
# Changelog
22

3-
## 3.4.0 (TBA)
3+
## 3.4.0 (03/28/2025)
4+
5+
### Breaking
6+
7+
* Drop support for EOL Python 3.8 version.
8+
9+
### Bugfixes
10+
11+
* Fix duplicate pages information shown in pages like `du`, `cd`, `w` (thanks [@sellisd](https://github.com/sellisd))
12+
* Only install `colorama` in Windows devices (thanks [@hukkin](https://github.com/hukkin))
13+
* Fix broken `--render` option (thanks [@acuteenvy](https://github.com/acuteenvy))
414

515
### Features
616

7-
* Add support for option placeholders
17+
* Add support for displaying long/short option placeholders using `--short-options`/`--long-options` flag or [TLDR_OPTIONS variable](https://github.com/tldr-pages/tldr-python-client#command-options) (thanks [@Managor](https://github.com/Managor))
18+
* Add `--clear-cache`/`-k` option to clear tldr's local cache (thanks [@patricedenis](https://github.com/patricedenis) and [@vitorhcl](https://github.com/vitorhcl))
19+
* Add support to stylize text inside backticks when appearing in example description (thanks [@kyluca](https://github.com/kyluca))
20+
* Add support for specifying a certificate bundle with TLDR_CERT (thanks [@jtcbrule](https://github.com/jtcbrule), [@CleanMachine1](https://github.com/CleanMachine1), and [@vitorhcl](https://github.com/vitorhcl))
21+
* Package build has been migrated from using `setup.py` to `pyproject.toml` with Hatch backend and updated package metadata (thanks [@kbdharun](https://github.com/kbdharun))
22+
* Add trusted publisher support to securely publish `tldr` package to PyPI directly from the repository's confined environment (thanks [@kbdharun](https://github.com/kbdharun))
823

924
## 3.3.0 (06/29/2024)
1025

11-
## Breaking
26+
### Breaking
1227

1328
* Drop support for EOL versions Python 3.6 and Python 3.7.
1429

docs/man/tldr.1

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
2727
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
2828
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
2929
..
30-
.TH "TLDR" "1" "Jun 29, 2024" "" "tldr"
30+
.TH "TLDR" "1" "Mar 28, 2025" "" "tldr"
3131
.SH NAME
3232
tldr \- tldr 3.4.0
3333
.sp
@@ -61,6 +61,11 @@ Update the local cache of pages and exit
6161
.sp
6262
Default: False
6363
.TP
64+
.B \-k, \-\-clear\-cache
65+
Delete the local cache of pages and exit
66+
.sp
67+
Default: False
68+
.TP
6469
.B \-p, \-\-platform
6570
Possible choices: android, freebsd, linux, netbsd, openbsd, osx, sunos, windows, common
6671
.sp
@@ -92,6 +97,16 @@ Just print the plain page file.
9297
.sp
9398
Default: False
9499
.TP
100+
.B \-\-short\-options
101+
Display shortform options over longform
102+
.sp
103+
Default: False
104+
.TP
105+
.B \-\-long\-options
106+
Display longform options over shortform
107+
.sp
108+
Default: False
109+
.TP
95110
.B \-\-print\-completion
96111
Possible choices: bash, zsh, tcsh
97112
.sp

snap/snapcraft.yaml

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -31,14 +31,6 @@ parts:
3131
build-environment:
3232
- PATH: ${CRAFT_PART_INSTALL}/bin:${PATH}
3333
- PYTHONPATH: ${CRAFT_PART_INSTALL}/lib/python3.12/site-packages
34-
override-pull: |
35-
craftctl default
36-
override-build: |
37-
craftctl default
38-
cd $CRAFT_PART_SRC/docs
39-
make man
40-
mkdir -p $CRAFT_PART_INSTALL/share/man/man1
41-
cp -r $CRAFT_PART_SRC/docs/man/tldr.1 $CRAFT_PART_INSTALL/share/man/man1/tldr.1
4234
python-packages:
4335
- Sphinx
4436
- sphinx-argparse

0 commit comments

Comments
 (0)