Influxdata
/
docs-v2
mirror of https://github.com/influxdata/docs-v2.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
docs-v2/.github/pull_request_template/influxdb_v1_release.md

2.6 KiB
Raw Blame History

InfluxDB v1 Release Documentation

Release Version: v1.x.x Release Type: [ ] OSS [ ] Enterprise

[!Important] Always create separate PRs for OSS and Enterprise releases. OSS can publish immediately when the GitHub release tag is available. Enterprise must wait until the release artifact is GA in the InfluxData portal. Never combine both products in a single release PR.

Description

Brief description of the release and documentation changes.

Pre-merge Gate (Enterprise only)

  • Confirm release artifact is GA in the InfluxData portal
  • v1 codeowner has signaled readiness (e.g., applied a release label)

Release Documentation Checklist

Release Notes

  • Generate release notes from changelog
    • OSS: Use commit messages from GitHub release tag https://github.com/influxdata/influxdb/releases/tag/v1.x.x
    • Enterprise: Use https://dl.influxdata.com/enterprise/nightlies/master/CHANGELOG.md
    • Note: For Enterprise releases, include important updates, features, and fixes from the corresponding OSS tag
  • Update release notes in appropriate location
    • OSS: content/influxdb/v1/about_the_project/release-notes.md
    • Enterprise: content/enterprise_influxdb/v1/about-the-project/release-notes.md
  • Ensure release notes follow documentation formatting standards

Version Updates

  • Update patch version in data/products.yml (only for this product)
    • OSS: influxdb > latest_patches > v1
    • Enterprise: enterprise_influxdb > latest_patches > v1
  • Update version references in documentation
    • Installation guides
    • Docker documentation
    • Download links
    • Code examples with version-specific commands

Content Verification

  • Review breaking changes and update migration guides if needed
  • Update compatibility matrices if applicable
  • Verify all download links work correctly
  • Check that version-specific features are documented

Testing

  • Build documentation locally and verify changes render correctly
  • Test all updated links
  • Run link validation for the product being released:
    • OSS: yarn test:links content/influxdb/v1/**/*.md
    • Enterprise: yarn test:links content/enterprise_influxdb/v1/**/*.md

Related Resources

Post-Merge Actions

  • Verify documentation is deployed to production
  • Announce in #docs channel
  • Close related DAR issue(s)