From ad7cfd44d4bfc32eb9c702835b336495b9bf54da Mon Sep 17 00:00:00 2001 From: Ivan Habunek Date: Wed, 13 Dec 2023 15:11:45 +0100 Subject: [PATCH] Update changelog --- CHANGELOG.md | 25 +++++++++++++++++++++---- changelog.yaml | 12 +++++++++++- docs/changelog.md | 25 +++++++++++++++++++++---- scripts/generate_changelog | 7 +++++++ 4 files changed, 60 insertions(+), 9 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8f236c3..eb94777 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,11 +5,28 @@ Changelog **0.40.0 (TBA)** -* Migrate to `click` for commandline arguments. BC should be mostly preserved, - please report any issues. +This release includes a major rewrite to use +[Click](https://click.palletsprojects.com/) for creating the command line +interface. This allows for some new features like nested commands, setting +parameters via environment variables, and shell completion. See docs for +details. Backward compatibility should be mostly preserved, except for cases +noted below please report any issues. + +* BREAKING: Remove deprecated `--disable-https` option for `login` and + `login_cli`, pass the base URL instead +* BREAKING: Options `--debug`, `--color`, `--quiet` must be specified after + `toot` but before the command +* Enable passing params via environment variables, see: + https://toot.bezdomni.net/environment_variables.html * Add shell completion, see: https://toot.bezdomni.net/shell_completion.html -* Remove deprecated `--disable-https` option for `login` and `login_cli`, pass - the base URL instead +* Add `--json` option to tag commands +* Add `tags info`, `tags featured`, `tags feature`, and `tags unfeature` + commands +* Add `tags followed`, `tags follow`, and `tags unfollow` commands, deprecate + `tags_followed`, `tags_follow`, and `tags tags_unfollow` +* Add `toot --width` option for setting your prefered terminal width +* Add `--media-viewer` and `--colors` options to `toot tui`. These were + previously accessible only via settings. **0.39.0 (2023-11-23)** diff --git a/changelog.yaml b/changelog.yaml index 5713612..6d2539d 100644 --- a/changelog.yaml +++ b/changelog.yaml @@ -1,11 +1,21 @@ 0.40.0: date: TBA + description: | + This release includes a major rewrite to use [Click](https://click.palletsprojects.com/) for + creating the command line interface. This allows for some new features like nested commands, + setting parameters via environment variables, and shell completion. See docs for details. + Backward compatibility should be mostly preserved, except for cases noted below please report + any issues. changes: - "BREAKING: Remove deprecated `--disable-https` option for `login` and `login_cli`, pass the base URL instead" - - "Migrate to `click` for commandline arguments. BC should be mostly preserved, please report any issues." + - "BREAKING: Options `--debug`, `--color`, `--quiet` must be specified after `toot` but before the command" + - "Enable passing params via environment variables, see: https://toot.bezdomni.net/environment_variables.html" - "Add shell completion, see: https://toot.bezdomni.net/shell_completion.html" - "Add `--json` option to tag commands" - "Add `tags info`, `tags featured`, `tags feature`, and `tags unfeature` commands" + - "Add `tags followed`, `tags follow`, and `tags unfollow` commands, deprecate `tags_followed`, `tags_follow`, and `tags tags_unfollow`" + - "Add `toot --width` option for setting your prefered terminal width" + - "Add `--media-viewer` and `--colors` options to `toot tui`. These were previously accessible only via settings." 0.39.0: date: 2023-11-23 diff --git a/docs/changelog.md b/docs/changelog.md index 8f236c3..eb94777 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -5,11 +5,28 @@ Changelog **0.40.0 (TBA)** -* Migrate to `click` for commandline arguments. BC should be mostly preserved, - please report any issues. +This release includes a major rewrite to use +[Click](https://click.palletsprojects.com/) for creating the command line +interface. This allows for some new features like nested commands, setting +parameters via environment variables, and shell completion. See docs for +details. Backward compatibility should be mostly preserved, except for cases +noted below please report any issues. + +* BREAKING: Remove deprecated `--disable-https` option for `login` and + `login_cli`, pass the base URL instead +* BREAKING: Options `--debug`, `--color`, `--quiet` must be specified after + `toot` but before the command +* Enable passing params via environment variables, see: + https://toot.bezdomni.net/environment_variables.html * Add shell completion, see: https://toot.bezdomni.net/shell_completion.html -* Remove deprecated `--disable-https` option for `login` and `login_cli`, pass - the base URL instead +* Add `--json` option to tag commands +* Add `tags info`, `tags featured`, `tags feature`, and `tags unfeature` + commands +* Add `tags followed`, `tags follow`, and `tags unfollow` commands, deprecate + `tags_followed`, `tags_follow`, and `tags tags_unfollow` +* Add `toot --width` option for setting your prefered terminal width +* Add `--media-viewer` and `--colors` options to `toot tui`. These were + previously accessible only via settings. **0.39.0 (2023-11-23)** diff --git a/scripts/generate_changelog b/scripts/generate_changelog index 5e6021e..8aa5d6c 100755 --- a/scripts/generate_changelog +++ b/scripts/generate_changelog @@ -21,6 +21,13 @@ for version in data.keys(): changes = data[version]["changes"] print(f"**{version} ({date})**") print() + + if "description" in data[version]: + description = data[version]["description"].strip() + for line in textwrap.wrap(description, 80): + print(line) + print() + for c in changes: lines = textwrap.wrap(c, 78) initial = True