.. Copyright (C) 2018, 2020, 2024 Branko Majic

   This file is part of Gimmecert documentation.

   This work is licensed under the Creative Commons Attribution-ShareAlike 3.0
   Unported License. To view a copy of this license, visit
   http://creativecommons.org/licenses/by-sa/3.0/ or send a letter to Creative
   Commons, 444 Castro Street, Suite 900, Mountain View, California, 94041, USA.


Release notes
=============


NEXT RELEASE
------------

This release adds support for Python 3.10, 3.11, and 3.12, while
dropping support for Python 3.5, 3.6, and 3.7. Package dependencies
have been updated as well.

.. warning::

   This release contains the following breaking changes:

   - Support for Python 3.5, 3.6, and 3.7 has been dropped. Make sure
     that you are using one of the supported Python versions prior to
     upgrading *Gimmecert*.

Resolved issues:

- **Tasks**:

  - `GC-42: Support for Python 3.10 <https://projects.majic.rs/gimmecert/issues/GC-42>`_
  - `GC-43: Support for Python 3.11 <https://projects.majic.rs/gimmecert/issues/GC-43>`_
  - `GC-44: Support for Python 3.12 <https://projects.majic.rs/gimmecert/issues/GC-44>`_
  - `GC-45: Drop support for Python 3.5, Python 3.6, and Python 3.7 <https://projects.majic.rs/gimmecert/issues/GC-45>`_


0.5.0
-----

This release adds support for Python 3.9, and updates the package
requirements.

Resolved issues:

- **Tasks**:

  - `GC-39: Support for Python 3.9 <https://projects.majic.rs/gimmecert/issues/GC-39>`_
  - `GC-40: Update all requirements <https://projects.majic.rs/gimmecert/issues/GC-40>`_


0.4.0
-----

This release adds support for picking the key algorithm and parameters
used for generating the private keys, and support for using ECDSA
keys.

Resolved issues:

- **User stories**:

  - `GC-36: As a system integrator, I want to be able to generate and use ECDSA keys <https://projects.majic.rs/gimmecert/issues/GC-36>`_

- **Feature requests**:

  - `GC-37: Ability to provide private key specification for key generation <https://projects.majic.rs/gimmecert/issues/GC-37>`_


0.3.0
-----

This release adds support for Python 3.8, drops support for Python
3.4, and updates the package requirements.

.. warning::

   This release contains the following breaking changes:

   - Support for Python 3.4 has been dropped. Make sure that you are
     using one of the supported Python versions prior to upgrading
     *Gimmecert*.

Resolved issues:

- **Tasks**:

  - `GC-32: Support for Python 3.8 <https://projects.majic.rs/gimmecert/issues/GC-32>`_
  - `GC-33: Update all requirements <https://projects.majic.rs/gimmecert/issues/GC-33>`_
  - `GC-35: Drop support for Python 3.4 <https://projects.majic.rs/gimmecert/issues/GC-35>`_


0.2.0
-----

This release is mostly oriented towards smaller bug-fixes, updates of
package dependencies, and improving the ease of testing during
development.

Resolved issues:

- **Bugs**:

  - `GC-26 - Wrong issuer DN for end entity certificates when CA hierarchy depth is 2 or more  <https://projects.majic.rs/gimmecert/issues/GC-26>`_

- **Feature requests**

  - `GC-29 - Prevent installation on unsupported Python versions <https://projects.majic.rs/gimmecert/issues/GC-29>`_
  - `GC-28 - Vagrant set-up for running tests against multiple Python versions <https://projects.majic.rs/gimmecert/issues/GC-28>`_
  - `GC-30 - Support for Python 3.7 <https://projects.majic.rs/gimmecert/issues/GC-30>`_

- **Tasks**

  - `GC-27 - Update all requirements <https://projects.majic.rs/gimmecert/issues/GC-27>`_


0.1.0
-----

First release of Gimmecert. Implements ability to set-up per-directory
CA hierarchy that can then be used to issue server and client
certificates.

Resolved issues:

- **User stories**:

  - `GC-4: As a system integrator, I want to easily issue server and client certificates so that I can quickly test software that requires them <https://projects.majic.rs/gimmecert/issues/GC-4>`_
  - `GC-5: As a system integrator, I want to initialise a CA hierarchy in project directory in order to use it within the project <https://projects.majic.rs/gimmecert/issues/GC-5>`_
  - `GC-6: As a system integrator, I want to issue server certificates so I can deploy them for use with server applications I use <https://projects.majic.rs/gimmecert/issues/GC-6>`_
  - `GC-7: As a system integrator, I want to issue client certificates so I can deploy them for use with client applications I use  <https://projects.majic.rs/gimmecert/issues/GC-7>`_
  - `GC-8: As a system integrator, I want to get status of current CA hierarchy and issued certificates so I could determine if I need to take an action <https://projects.majic.rs/gimmecert/issues/GC-8>`_
  - `GC-9: As a system integrator, I want to renew server or client certificate in order to change the additional naming or renew expigration date <https://projects.majic.rs/gimmecert/issues/GC-9>`_
  - `GC-10: As a system integrator, I want to be able to see tool's help in CLI so I can remind myself what commands are available <https://projects.majic.rs/gimmecert/issues/GC-10>`_
  - `GC-21: As a system integrator, I want to be able to issue certificates using a CSR so I can generate my own private key <https://projects.majic.rs/gimmecert/issues/GC-21>`_

- **Feature requests**:

  - `GC-2: Project skeleton <https://projects.majic.rs/gimmecert/issues/GC-2>`_
  - `GC-3: Ability to initialise CA hierarchy <https://projects.majic.rs/gimmecert/issues/GC-3>`_
  - `GC-11: Initial skeleton CLI implementation <https://projects.majic.rs/gimmecert/issues/GC-11>`_
  - `GC-12: Initial installation and usage instructions <https://projects.majic.rs/gimmecert/issues/GC-12>`_
  - `GC-15: Ability to issue server certificates <https://projects.majic.rs/gimmecert/issues/GC-15>`_
  - `GC-16: Ability to issue client certificates <https://projects.majic.rs/gimmecert/issues/GC-16>`_
  - `GC-19: Ability to update server certificate DNS subject alternative names <https://projects.majic.rs/gimmecert/issues/GC-19>`_
  - `GC-18: Ability to renew existing certificates <https://projects.majic.rs/gimmecert/issues/GC-18>`_
  - `GC-20: Ability to display status <https://projects.majic.rs/gimmecert/issues/GC-20>`_
  - `GC-22: Ability to provide CSR for issuing and renewing certificates <https://projects.majic.rs/gimmecert/issues/GC-22>`_

- **Enhancements**:

  - `GC-14: Clean-up test runtime configuration and imrpove usability  <https://projects.majic.rs/gimmecert/issues/GC-14>`_

- **Tasks**:

  - `GC-1: Set-up project infrastructure <https://projects.majic.rs/gimmecert/issues/GC-1>`_
  - `GC-17: Refactor CLI command handling and relevant tests <https://projects.majic.rs/gimmecert/issues/GC-17>`_