docs-v2/helper-scripts
Jason Stirnaman 3d1ef2bfc3 feat(helper-scripts): Enhance release notes generation with multi-repo and API change detection
- Add support for multiple repositories (primary + additional repos)
- Automatically fetch latest commits from all repositories by default
- Add --no-fetch and --pull command-line options for different workflows
- Detect and categorize REST API changes across v1, v2, v3 endpoints
- Include specific API endpoint analysis (/write, /query, /ping, /health, /metrics)
- Add repository tagging to commit categorization for multi-repo visibility
- Improve error handling with fallback options for git operations

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-06-27 15:26:28 -05:00
..
README.md Add release artifacts to Clustered release notes (#6132) 2025-06-10 16:57:08 -05:00
clustered-release-artifacts.sh Add release artifacts to Clustered release notes (#6132) 2025-06-10 16:57:08 -05:00
generate-release-notes.sh feat(helper-scripts): Enhance release notes generation with multi-repo and API change detection 2025-06-27 15:26:28 -05:00

README.md

InfluxData documentation helper scripts

This directory contains scripts designed to help make specific maintenance processes easier.

InfluxDB Clustered release artifacts

Script: ./clustered-release-artifacts.sh

Each InfluxDB Clustered release has the following associated artifacts that need to be provided with the release notes:

  • example-customer.yaml
  • app-instance-schema.json

This script uses an InfluxDB Clustered pull secret to pull down the required assets and store them in static/downloads/clustered-release-artifacts/<RELEASE>.

  1. Set up the pull secret:

    The Clustered Pull Secret (config.json) is available in Docs Team 1Password vault. Download the pull secret and store it in the /tmp/influxdbsecret directory on your local machine.

  2. Install dependencies:

  3. From the root of the docs project directory, run the following command to execute the script. Provide the release version as an argument to the script--for example:

    sh ./helper-scripts/clustered-release-artifacts.sh 20250508-1719206