Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions .claude/agents/influxdb1-tech-writer.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,15 @@ You are an expert InfluxDB v1 technical writer with deep knowledge of InfluxData
5. **Apply Standards:** Ensure compliance with style guidelines and documentation conventions
6. **Cross-Reference:** Verify consistency with related documentation and product variants

## Release Documentation Workflow

**Always create separate PRs for OSS v1 and Enterprise v1 releases.**

- **OSS v1:** Publish immediately when the release tag is available on GitHub (`https://github.com/influxdata/influxdb/releases/tag/v1.x.x`).
- **Enterprise v1:** Publish only after the release artifact is generally available (GA) in the InfluxData portal. Create the PR as a **draft** until the v1 codeowner signals readiness (e.g., applies a release label).
- **`data/products.yml`:** Split version bumps per product. The OSS PR bumps `influxdb.latest_patches.v1`; the Enterprise PR bumps `enterprise_influxdb.latest_patches.v1`.
- **PR template:** Use `.github/pull_request_template/influxdb_v1_release.md` and select the appropriate release type (OSS or Enterprise).

## Quality Assurance

- All code examples must be testable and include proper pytest-codeblocks annotations
Expand Down
23 changes: 23 additions & 0 deletions .claude/commands/prepare-release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -222,6 +222,29 @@ influxdb3_core, influxdb3_enterprise, telegraf
/influxdb3/core, /influxdb3/enterprise, /telegraf
```

## v1 Release Workflow

**InfluxDB v1 releases require separate PRs for OSS and Enterprise.**

1. **OSS PR** — publish immediately when the GitHub release tag is available.
2. **Enterprise PR** — create as a draft; merge only after the v1 codeowner signals readiness (e.g., applies a release label) and the release artifact is GA in the InfluxData portal.

Each PR should bump only its own product version in `data/products.yml`:
- OSS: `influxdb > latest_patches > v1`
- Enterprise: `enterprise_influxdb > latest_patches > v1`

Use the PR template `.github/pull_request_template/influxdb_v1_release.md` and select the appropriate release type.

### Examples for v1

```bash
# Generate OSS v1 release notes
docs release-notes v1.12.2 v1.12.3 --repos ~/github/influxdata/influxdb

# Generate Enterprise v1 release notes (separate PR)
# Use the Enterprise changelog at https://dl.influxdata.com/enterprise/nightlies/master/CHANGELOG.md
```

## Related

- **docs-cli-workflow** skill - When to use CLI tools
Expand Down
38 changes: 23 additions & 15 deletions .github/pull_request_template/influxdb_v1_release.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,37 @@
## InfluxDB v1 Release Documentation

**Release Version:** v1.x.x
**Release Type:** [ ] OSS [ ] Enterprise [ ] Both
**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
- 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/releasenotes-changelog.md`
- [ ] Enterprise: `/content/enterprise_influxdb/v1/about-the-project/release-notes.md`
- 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`
- [ ] OSS: `influxdb > v1 > latest`
- [ ] Enterprise: `enterprise_influxdb > v1 > latest`
- [ ] 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
Expand All @@ -37,8 +47,9 @@ Brief description of the release and documentation changes.
#### Testing
- [ ] Build documentation locally and verify changes render correctly
- [ ] Test all updated links
- [ ] Run link validation: `yarn test:links content/influxdb/v1/**/*.md`
- [ ] Run link validation: `yarn test:links content/enterprise_influxdb/v1/**/*.md`
- [ ] 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
- DAR Issue: #
Expand All @@ -50,6 +61,3 @@ Brief description of the release and documentation changes.
- [ ] Verify documentation is deployed to production
- [ ] Announce in #docs channel
- [ ] Close related DAR issue(s)

---
**Note:** For Enterprise releases, ensure you have access to the Enterprise changelog and coordinate with the release team for timing.
Loading
Loading