From 6c410ca5bfce90d0364d516e50d3745ff747b07a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Daniel=20Sta=C5=9Bczak?= <dstasczak@apptension.com>
Date: Thu, 28 Dec 2023 22:41:03 +0100
Subject: [PATCH] Document the project's version history

---
 CHANGELOG.md | 73 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 73 insertions(+)
 create mode 100644 CHANGELOG.md

diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000..c961b94
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,73 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning's recommendation in regard to initial development phase](https://semver.org/spec/v2.0.0.html#how-should-i-deal-with-revisions-in-the-0yz-initial-development-phase).
+
+<!--
+Types of changes:
+- Added for new features.
+- Changed for changes in existing functionality.
+- Deprecated for soon-to-be removed features.
+- Removed for now removed features.
+- Fixed for any bug fixes.
+- Security in case of vulnerabilities.
+-->
+
+## [Unreleased]
+
+### Added
+
+- Documentation of the project's roadmap (PR #50, #70).
+- Command to echo database version and file path (issue #32, PR #67).
+- Command to echo the application's version (issue #71, PR #72).
+- `--debug/--no-debug` option, which allows to enable or disable debug info (PR #82).
+
+### Changed
+
+- The `black` pre-commit hook to the official faster mirror (PR #73).
+
+### Removed
+
+- The `show-all` command (issue #27, PR #40).
+
+### Fixed
+
+- The app always reads/writes the database in the current directory. Now, the
+  app stores a local database in the OS-specific data directory (issue #26, PR
+  #31).
+- The counter in HOTP is incremented _after_ the OTP is shown. Now, it is
+  correctly incremented _before_ the OTP is shown (issue #39, PR #41).
+- `add hotp` raises unhandled exception on missing `-c, --counter` option. Now,
+  it defaults to `0` (issue #33, PR #42).
+- The app does not store `label` and `issuer` parameters. Now, it stores them
+  (issue #34, PR #44).
+- Invalid type annotation of `wait` option (PR #45).
+- Error message for invalid hash algorithm shows the implementation details.
+  Now, it shows the possible values expected from the user (issue #46, PR #48).
+- `otp -k key` raises unhandled exception if the keyring is not installed. Now,
+  it shows an appropriate error message (issue #56, PR #57).
+- `add uri` command does not conform in 100% to the Key Uri Format
+  specification: `secret` parameter is handled as plain text, not Base32; some
+  parameters that are supposed to be optional according to the spec, are
+  required by the application. Now, it conforms (issue #37, PR #58).
+- Redundant re-input of database password. Now, it is removed (PR #58).
+- `secret` string is handled as-is, not interpreted as the Base32. Now, it is
+  interpreted as the Base32 (issue #38, PR #65).
+- Shadowed variable `algorithm`. Now, it is renamed, along with several other
+  variables named `*algorithm` (issue #47, PR #68).
+- Regression after renaming `*algorithm` variables (issue #75, PR #76).
+- `digits` parameter in URI not being optional. Now, it is optional (issue #77, PR #78).
+- `secret` not being case-insensitive (issue #80, PR #81).
+- CI/CD after periodic breakdowns (issue #51, #61; PR #52, #62, #66).
+
+## [0.1.0] - 2021-12-06
+
+### Added
+
+- All the basic commands
+- All the nice-to-have commands
+
+[unreleased]: https://github.com/apptension/onetimepass/compare/0.1.0...HEAD
+[0.1.0]: https://github.com/apptension/onetimepass/releases/tag/0.1.0