Skip to content

Commit

Permalink
doc
Browse files Browse the repository at this point in the history
  • Loading branch information
dvershinin committed Aug 6, 2021
1 parent e1a2b41 commit 975d40a
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 1 deletion.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
# Changelog
All notable changes to this project will be documented in this file.

## [1.5.0] - 2021-08-06
### Added
* New `--having-asset` switch to consider only formal releases with given asset name
### Fixed
* Unnecessary parsing of repo argument as version (performance)

## [1.4.5] - 2021-07-16
### Fixed
* Fixed RPM builds rpmlint changelog-time-in-future by having changelog in UTC
Expand Down
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,8 @@ optional arguments:
--only ONLY Only consider releases containing this text. Useful
for repos with multiple projects inside
--filter REGEX Filters --assets result by a regular expression
--having-asset [ASSET]
Only consider releases with this asset
-su, --shorter-urls A tiny bit shorter URLs produced
--at {github,gitlab,bitbucket,pip,hg,sf,website-feed,local}
If the repo argument is one word, specifies where to
Expand Down Expand Up @@ -273,6 +275,26 @@ The branch selector can also be used to get specific release details, e.g.:
lastversion php:7.2.33 --assets
```

### Use case: releases with specific assets or formal releases only

Sometimes a project makes nice formal releases but delay in uploading assets for releases.
And you might be interested in specific asset type always.
Then you can make `lastversion` consider as latest only the last release with specific asset name.
Easy with the `--having-asset` switch:

```bash
lastversion telegramdesktop/tdesktop --having-asset "Linux 64 bit: Binary"
```

In other situations, you want to consider only latest *formal* release in GitHub. Then you can use
`--having-asset` without a value. This is useful when you want to disregard any bare "tag"
releases from GitHub. Counter-intuitively, this may return a formal releases without any other
assets than source code alone.

```bash
lastversion telegramdesktop/tdesktop --having-asset
```

### Use case: version of an operating system

The operating systems are usually *not* versioned through GitHub releases or such.
Expand Down
2 changes: 1 addition & 1 deletion lastversion/__about__.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = '1.4.5'
__version__ = '1.5.0'

0 comments on commit 975d40a

Please sign in to comment.