Skip to content

Python script to generate NGINX Agent changelog markdown document based on the GitHub changelog.

License

Notifications You must be signed in to change notification settings

nginx/agent-changelog

Project Status: Active – The project has reached a stable, usable state and is being actively developed. OpenSSF Scorecard Community Support Contributor Covenant

NGINX Agent Changelog generation script

Description

The agent.py script is a tool that grabs the required content from the NGINX Agent Changelog in GitHub and generates the Hugo content to be used in the NGINX Agent Changelog page

The template.j2 file is the Jinja2 template used to generate the Hugo content.

Installation

  1. Clone the repository
  2. Install the required dependencies: pip install -r requirements.txt

Usage

Run this script within a GitHub Actions workflow to generate a changelog.

Make sure to define the GitHub token as an environment variable.

To run the script, use the following command:

python agent.py

The script will generate the changelog.md file in the same folder as the script containing the changes from the last 10 releases.

The genrated changelog.md can be copied directly to the /site/content/ folder in the NGINX Agent repository.

License

Apache License, Version 2.0

© F5, Inc. 2024

About

Python script to generate NGINX Agent changelog markdown document based on the GitHub changelog.

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published