https://github.com/nginx/agent-changelog

Python script to generate NGINX Agent changelog markdown document based on the GitHub changelog.
https://github.com/nginx/agent-changelog

Last synced: 10 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/nginx/agent-changelog
• Owner: nginx
• License: apache-2.0
• Created: 2024-02-14T16:07:52.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-09-04T14:04:05.000Z (over 1 year ago)
• Last Synced: 2025-03-03T09:11:54.121Z (10 months ago)
• Language: Python
• Size: 57.6 KB
• Stars: 1
• Watchers: 4
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md
  • Support: SUPPORT.md

Awesome Lists containing this project

README

          
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)

[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/nginx/agent-changelog/badge)](https://securityscorecards.dev/viewer/?uri=github.com/nginx/agent-changelog)

[![Community Support](https://badgen.net/badge/support/community/cyan?icon=awesome)](https://github.com/nginx/agent-changelog/blob/main/SUPPORT.md)

[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](https://github.com/nginx/agent-changelog/blob/main/CODE_OF_CONDUCT.md)

# 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](https://github.com/nginx/agent/releases) and generates the Hugo content to be used in the [NGINX Agent Changelog page](https://docs.nginx.com/nginx-agent/changelog/)

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](https://github.com/nginx/agent/tree/main/site/content).

## License

[Apache License, Version 2.0](https://github.com/nginx/agent-changelog/blob/main/LICENSE)

© [F5, Inc.](https://www.f5.com/) 2024