https://github.com/ttldtor/releasenotesretriever
A utility that helps retrieve lines from Release Notes that refer to the latest version of an application or library mentioned there, or to a specified version.
https://github.com/ttldtor/releasenotesretriever
Last synced: 5 months ago
JSON representation
A utility that helps retrieve lines from Release Notes that refer to the latest version of an application or library mentioned there, or to a specified version.
- Host: GitHub
- URL: https://github.com/ttldtor/releasenotesretriever
- Owner: ttldtor
- License: unlicense
- Created: 2022-07-05T19:55:56.000Z (about 4 years ago)
- Default Branch: default
- Last Pushed: 2022-07-05T19:59:27.000Z (about 4 years ago)
- Last Synced: 2025-06-12T17:49:52.355Z (about 1 year ago)
- Language: D
- Size: 3.91 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Release Notes Retiever
[](https://github.com/ttldtor/ReleaseNotesRetriever/releases/latest)
[](https://github.com/ttldtor/ReleaseNotesRetriever/blob/master/LICENSE)
**A utility that helps retrieve lines from Release Notes that refer to the latest version of an application or
library mentioned there, or to a specified version.**
Key features:
- receives on stdin a stream of lines from the ReleaseNotes file
- according to the pattern specified in the environment variable, determines what is information about the version of the application
- according to the specified version in the environment variable, finds information about this version
- if the version is not specified, then finds information about the latest version
- output to stdout a stream of lines related to the application version
Possible environment variables:
|Name|Description|Default Value|Example|
|----|-----------|-------------|-------|
|RELEASE_NOTES_VERSION_PATTERN|Template for version matching. Specified as RegExp|`^v[0-9]+\.[0-9]+\.[0-9]+.*$`|`^[0-9]+\.[0-9]+\.[0-9]+.*$`|
|RELEASE_NOTES_VERSION_TO_RETRIEVE|The version of the application or library for which you want to find information in the ReleaseNotes||`v2.0.0`|
## Examples
Possible ReleaseNotes format:
```txt
```
Example:
```md
Release Notes
==
v2.0.0
- Fixed something
- Added some changes
v1.0.0
- Implemented something
- Init release
```
Example of usage #1:
```powershell
Get-Content "C:\Project\ReleaseNotes.md" | & rdmd ./rnr.d
```
Example of output #1:
```powershell
- Fixed something
- Added some changes
```
Example of usage #2:
```powershell
$env:RELEASE_NOTES_VERSION_TO_RETRIEVE = 'v1.0.0'
Get-Content "C:\Project\ReleaseNotes.md" | & rdmd ./rnr.d
```
Example of output #2:
```powershell
- Implemented something
- Init release
```
Example of usage #3:
```bash
export RELEASE_NOTES_VERSION_PATTERN='v[0-9]+\.[0-9]+\.[0-9]+.*$'
export RELEASE_NOTES_VERSION_TO_RETRIEVE='v1.0.0'
cat ~/Project/ReleaseNotes.md | rdmd ./rnr.d
```
Example of output #3:
```powershell
- Implemented something
- Init release
```