helper-scripts directory to:
1. Main helper-scripts/README.md:
Updated to describe
generate-release-notes.js instead of
the old bash script, including new
configuration options and examples.
2. helper-scripts/common/README.md:
Updated to describe the JavaScript
version with all its new features like
configuration files,
integrated/separated formats, and PR
link options.
3. helper-scripts/influxdb3-monolith/RE
ADME.md: Completely updated to reflect
the actual JavaScript scripts present
(audit-cli-documentation.js and
apply-cli-patches.js) instead of the
non-existent bash scripts, updated
prerequisites, examples, and workflow
documentation.
script with the following improvements:
1. Renamed output formats:
- standard → integrated: All repositories' changes are
integrated together
- core-enterprise → separated: Primary repository
first, then secondary repositories
2. Generalized the separated format:
- Configurable primary repository (by name or index)
- Customizable section labels and headers
- Flexible template system for different products
3. Enhanced configuration system:
- Per-repository PR link settings
- Full template customization for separated format
- Support for configuration files
4. Created example configurations:
- config/influxdb3-core-enterprise.json: For InfluxDB 3
Core/Enterprise releases
- config/influxdb-v2.json: For InfluxDB v2 releases
- config/influxdb3-clustered.json: For Clustered
(Kubernetes operator) releases
5. Updated documentation:
- Explained both output formats clearly
- Added configuration options documentation
- Included example configurations usage
The script now provides a flexible system that can handle
various release note formats for different InfluxData
products while maintaining the specific requirements like
excluding PR links for influxdb_pro but including them
for influxdb.
bullet point formatting like:
* feat: some feature * fix: some fix Changes made: 1. Added new function get_commits_with_body() that uses git log --format="%B" to get full commit messages 2. Updated pattern matching to handle both direct commits and bullet-pointed entries in merge commits (supporting both * and - bullets) 3. Modified the feature and fix extraction to check both commit subjects and commit bodies 4. Fixed pattern anchoring by removing ^ anchors when calling the body parsing function
scripts
- Supports special case for local development mode
- Provides helpful error messages with available tags
- Can be used as CLI tool or imported module
Jason Stirnaman