Skip to content

Commit

Permalink
Add Release Notes to About section
Browse files Browse the repository at this point in the history
  • Loading branch information
cdot65 committed Jan 21, 2024
1 parent e06b428 commit 61bbaf0
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 0 deletions.
46 changes: 46 additions & 0 deletions docs/about/release-notes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Release Notes

Welcome to the release notes for the `pan-os-upgrade` tool. This document provides a detailed record of changes, enhancements, and fixes in each version of the tool.

## Version 0.2.0

**Release Date:** *<20240121>*

### What's New

- Allow for simply running `pan-os-upgrade` without arguments, providing an interactive prompt for missing variables
- Replaced `argparse` with `typer` for command-line argument parsing, offering a more intuitive and user-friendly CLI experience.
- Removed the option for API key authentication to streamline the authentication process.
- Removed the `.env` file lookup feature. Configuration is now exclusively handled through command-line arguments.
- Updated the `hostname` variable to `ip_address` for clarity and consistency.
- Changed `target_version` parameter name to simply `version` to make it more concise.

### Breaking Changes

- Scripts and automation tools using the previous `argparse` syntax or `.env` file for configuration will need to be updated to use the new `typer` CLI arguments.

## Version 0.1.1

**Release Date:** *<20240119>*

### Highlights

- First official release of the `pan-os-upgrade` tool on PyPi.
- Made available for wide usage and distribution.

### Notes

- Includes all the features and functionalities as they were in the initial development build.

## Version 0.1.0

**Release Date:** *<20240118>*

### Introduction

- Initial development build of the `pan-os-upgrade` tool.
- Laid down the foundation for the tool's functionalities and features.

---

For more detailed information on each release, visit the [GitHub repository](https://github.com/cdot65/pan-os-upgrade/releases) or check the [commit history](https://github.com/cdot65/pan-os-upgrade/commits/main).
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,3 +29,4 @@ nav:
- About:
- License: about/license.md
- Contributing: about/contributing.md
- Release Notes: about/release-notes.md

0 comments on commit 61bbaf0

Please sign in to comment.