From 84f96f26c53b70b720b04ac07ab5e8dbc47046e6 Mon Sep 17 00:00:00 2001 From: Calvin Remsburg Date: Sat, 17 Feb 2024 10:21:13 -0600 Subject: [PATCH] update release and documentation --- README.md | 2 +- docker/Dockerfile | 4 ++-- docs/about/contributing.md | 8 ++++---- docs/about/release-notes.md | 10 ++++++++++ pyproject.toml | 2 +- tests/test_get_ha_status.py | 6 +++--- 6 files changed, 21 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index c528772..9cceaf2 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@
Logo -

PAN-OS Automation Project

+

PAN-OS and Panorama Upgrade Automation

Streamlining Palo Alto Networks Firewall Upgrades with Python Automation
diff --git a/docker/Dockerfile b/docker/Dockerfile index 8cab038..d037079 100644 --- a/docker/Dockerfile +++ b/docker/Dockerfile @@ -14,8 +14,8 @@ WORKDIR /app ADD settings.yaml /app # Install any needed packages specified in requirements.txt -# Note: The requirements.txt should contain pan-os-upgrade==1.2.5 -RUN pip install --no-cache-dir pan-os-upgrade==1.2.5 +# Note: The requirements.txt should contain pan-os-upgrade==1.2.6 +RUN pip install --no-cache-dir pan-os-upgrade==1.2.6 # Set the locale to avoid issues with emoji rendering ENV LANG C.UTF-8 diff --git a/docs/about/contributing.md b/docs/about/contributing.md index ec0b522..9f9454d 100644 --- a/docs/about/contributing.md +++ b/docs/about/contributing.md @@ -1,6 +1,6 @@ -# Contributing to PAN-OS Automation Project +# Contributing to `pan-os-upgrade` -We're thrilled that you're interested in contributing to the PAN-OS Automation Project! Your contributions are essential for making this project better and more effective. Whether you're fixing a bug, adding a new feature, improving the documentation, or just giving suggestions, every contribution is valuable. +We're thrilled that you're interested in contributing to the `pan-os-upgrade` project! Your contributions are essential for making this project better and more effective. Whether you're fixing a bug, adding a new feature, improving the documentation, or just giving suggestions, every contribution is valuable. --- @@ -10,7 +10,7 @@ Before you begin, make sure you have a GitHub account and are familiar with Git ### Setting Up Your Environment -1. **Fork the Repository:** Start by forking the [PAN-OS Automation Project repository](https://github.com/cdot65/pan-os-upgrade) on GitHub. +1. **Fork the Repository:** Start by forking the [pan-os-upgrade repository](https://github.com/cdot65/pan-os-upgrade) on GitHub. 2. **Clone Your Fork:** Clone your fork to your local machine: @@ -51,7 +51,7 @@ Before you begin, make sure you have a GitHub account and are familiar with Git git push origin feature/YourFeatureName ``` -2. **Create a Pull Request:** Go to the original PAN-OS Automation Project repository on GitHub and create a new pull request. Provide a clear description of your changes and any relevant issue numbers. +2. **Create a Pull Request:** Go to the original `pan-os-upgrade` repository on GitHub and create a new pull request. Provide a clear description of your changes and any relevant issue numbers. 3. **Code Review:** Wait for a review from the project maintainers. Be open to feedback and make any requested changes. diff --git a/docs/about/release-notes.md b/docs/about/release-notes.md index da6c0cd..24be609 100644 --- a/docs/about/release-notes.md +++ b/docs/about/release-notes.md @@ -2,6 +2,16 @@ 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 1.2.6 + +**Release Date:** *<20240217>* + + +### What's New + +- Move HA status collection within the `get_firewall_details` function for batch upgrades. +- Update interactive inventory menu to include HA role of the firewall and if it has `preempt` enabled. + ## Version 1.2.5 **Release Date:** *<20240215>* diff --git a/pyproject.toml b/pyproject.toml index 83ce2a0..5ab8ac2 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "pan-os-upgrade" -version = "1.2.5" +version = "1.2.6" description = "Python script to automate the upgrade process of PAN-OS firewalls." authors = ["Calvin Remsburg "] documentation = "https://cdot65.github.io/pan-os-upgrade/" diff --git a/tests/test_get_ha_status.py b/tests/test_get_ha_status.py index c4d26cb..0d0a363 100644 --- a/tests/test_get_ha_status.py +++ b/tests/test_get_ha_status.py @@ -11,9 +11,9 @@ ("panorama.cdot.io", "disabled", None), ("panorama1.cdot.io", "primary-active", None), ("panorama2.cdot.io", "secondary-passive", None), - ("houston.cdot.io", "disabled", None), - ("woodlands-fw1.cdot.io", "active", None), - ("woodlands-fw2.cdot.io", "passive", None), + ("lab-fw1.cdot.io", "disabled", None), + ("lab-fw6.cdot.io", "active", None), + ("lab-fw7.cdot.io", "passive", None), ]