changed changelog command to accept a version as argument

Fixed version numbering and typo in CHANGELOG

Fixes #116
This commit is contained in:
Abigail Gold 2020-01-04 15:24:33 -05:00
parent c7d0a85464
commit e7baca453c
No known key found for this signature in database
GPG Key ID: CF88335E873C3FB4
2 changed files with 33 additions and 18 deletions

View File

@ -5,9 +5,11 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
## [Unreleased] ## [Unreleased]
### Changed
- changelog command to accept a version as argument.
## [v2.1.0] - 2020-01-04 ## [2.1.0] - 2020-01-04
### Added ### Added
- New NATO "phonetics" command. - New NATO "phonetics" command.
- Flag emojis to commands with countries. - Flag emojis to commands with countries.
@ -18,14 +20,14 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
- Command linking to the issue tracker. - Command linking to the issue tracker.
- New key in options.py: pika. - New key in options.py: pika.
### Changed ### Changed
- The "phonetics" command is not called "funetics". - The "phonetics" command is now called "funetics".
- All commands now respond in embeds. - All commands now respond in embeds.
- Playing status can now change on a schedule or randomly from a list. - Playing status can now change on a schedule or randomly from a list.
### Fixed ### Fixed
- Fixed incorrect information in the `prefixes` command. - Fixed incorrect information in the `prefixes` command.
## [v2.0.0] - 2019-12-16 ## [2.0.0] - 2019-12-16
### Added ### Added
- Rich lookup for AE7Q.com (callsigns only, more to come) - Rich lookup for AE7Q.com (callsigns only, more to come)
- Rich lookup for QRZ.com, if a QRZ subscription is present - Rich lookup for QRZ.com, if a QRZ subscription is present
@ -52,9 +54,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
- Issue in morse and unmorse commands where spaces were not interpreted correctly - Issue in morse and unmorse commands where spaces were not interpreted correctly
## v1.0.0 - 2019-07-31 [YANKED] ## 1.0.0 - 2019-07-31 [YANKED]
[Unreleased]: https://github.com/classabbyamp/discord-qrm2/compare/v2.1.0...HEAD [Unreleased]: https://github.com/classabbyamp/discord-qrm2/compare/v2.1.0...HEAD
[v2.1.0]: https://github.com/classabbyamp/discord-qrm2/releases/tag/v2.1.0 [2.1.0]: https://github.com/classabbyamp/discord-qrm2/releases/tag/v2.1.0
[v2.0.0]: https://github.com/classabbyamp/discord-qrm2/releases/tag/v2.0.0 [2.0.0]: https://github.com/classabbyamp/discord-qrm2/releases/tag/v2.0.0

View File

@ -120,25 +120,38 @@ class BaseCog(commands.Cog):
await ctx.send(content, embed=embed) await ctx.send(content, embed=embed)
@commands.command(name="changelog", aliases=["clog"]) @commands.command(name="changelog", aliases=["clog"])
async def _changelog(self, ctx: commands.Context): async def _changelog(self, ctx: commands.Context, version: str = 'latest'):
"""Show what has changed in the most recent bot version.""" """Show what has changed in the most recent bot version."""
embed = cmn.embed_factory(ctx) embed = cmn.embed_factory(ctx)
embed.title = "qrm Changelog" embed.title = "qrm Changelog"
embed.description = ("For a full listing, visit [Github](https://" embed.description = ("For a full listing, visit [Github](https://"
"github.com/classabbyamp/discord-qrm2/blob/master/CHANGELOG.md).") "github.com/classabbyamp/discord-qrm2/blob/master/CHANGELOG.md).")
changelog = self.changelog changelog = self.changelog
vers = list(changelog.keys())
vers.remove("Unreleased")
vers = 0 version = version.lower()
for ver, log in changelog.items():
if ver.lower() != 'unreleased': if version == 'latest':
if 'date' in log: version = info.release
embed.description += f'\n\n**{ver}** ({log["date"]})' if version == 'unreleased':
else: version = 'Unreleased'
embed.description += f'\n\n**{ver}**'
embed = await format_changelog(log, embed) try:
vers += 1 log = changelog[version]
if vers >= 1: except KeyError:
break embed.title += ": Version Not Found"
embed.description += '\n\n**Valid versions:** latest, '
embed.description += ', '.join(vers)
embed.colour = cmn.colours.bad
await ctx.send(embed=embed)
return
if 'date' in log:
embed.description += f'\n\n**v{version}** ({log["date"]})'
else:
embed.description += f'\n\n**v{version}**'
embed = await format_changelog(log, embed)
await ctx.send(embed=embed) await ctx.send(embed=embed)