Skip to content

Commit ae85ae4

Browse files
jstirnamanjstirnaman
committed
Merge remote-tracking branch 'origin/jts-3-2-release-notes' into core-ent-3.2
2 parents ba1e7f8 + 1861136 commit ae85ae4

File tree

5 files changed

+436
-0
lines changed

5 files changed

+436
-0
lines changed

‎content/shared/v3-core-enterprise-release-notes/_index.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,57 @@
55
> All updates to Core are automatically included in Enterprise.
66
> The Enterprise sections below only list updates exclusive to Enterprise.
77
8+
## v3.2.0 {date="2025-06-25"}
9+
10+
**Core**: revision 1ca3168bee
11+
**Enterprise**: revision 1ca3168bee
12+
13+
### Core
14+
15+
#### Features
16+
17+
- **Hard delete for databases and tables**: Permanently delete databases and tables, enabling complete removal of data structures for compliance and storage management ([#26553](https://github.com/influxdata/influxdb/pull/26553))
18+
- **AWS credentials auto-reload**: Support dynamic reloading of ephemeral AWS credentials from files, improving security and reliability when using AWS services ([#26537](https://github.com/influxdata/influxdb/pull/26537))
19+
- **Database retention period support**: Add retention period support for databases via CLI commands (`create database` and `update database` commands) and HTTP APIs ([#26520](https://github.com/influxdata/influxdb/pull/26520)):
20+
- New CLI command: `update database --retention-period`
21+
- **Configurable lookback duration**: Users can specify lookback duration for PersistedFiles buffer, providing better control over query performance ([#26528](https://github.com/influxdata/influxdb/pull/26528))
22+
- **WAL replay concurrency control**: Add concurrency limits for WAL (Write-Ahead Log) replay to improve startup performance and resource management ([#26483](https://github.com/influxdata/influxdb/pull/26483))
23+
- **Enhanced write path**: Separate write path executor with unbounded memory for improved write performance ([#26455](https://github.com/influxdata/influxdb/pull/26455))
24+
25+
#### Bug Fixes
26+
27+
- **WAL corruption handling**: Handle corrupt WAL files during replay without panic, improving data recovery and system resilience ([#26556](https://github.com/influxdata/influxdb/pull/26556))
28+
- **Database naming validation**: Disallow underscores in database names when created via API to ensure consistency ([#26507](https://github.com/influxdata/influxdb/pull/26507))
29+
- **Object store cleanup**: Automatic intermediate directory cleanup for file object store, preventing storage bloat ([#26480](https://github.com/influxdata/influxdb/pull/26480))
30+
31+
#### Additional Updates
32+
33+
- Track generation 1 duration in catalog for better performance monitoring ([#26508](https://github.com/influxdata/influxdb/pull/26508))
34+
- Add retention period support to the catalog ([#26479](https://github.com/influxdata/influxdb/pull/26479))
35+
- Update help text for improved user experience ([#26509](https://github.com/influxdata/influxdb/pull/26509))
36+
37+
### Enterprise
38+
39+
All Core updates are included in Enterprise. Additional Enterprise-specific features and fixes:
40+
41+
#### Features
42+
43+
- **License management improvements**:
44+
- New `influxdb3 show license` command to display current license information
45+
- **Table-level retention period support**: Add retention period support for individual tables in addition to database-level retention, providing granular data lifecycle management
46+
- New CLI commands: `create table --retention-period` and `update table --retention-period`
47+
- Set or clear table-specific retention policies independent of database settings
48+
- **Compaction improvements**:
49+
- Address compactor restart issues for better reliability
50+
- Track compacted generation durations in catalog for monitoring
51+
- Disable parquet cache for ingest mode to optimize memory usage
52+
53+
#### Bug Fixes
54+
55+
- **Query optimization**: Correctly partition query chunks into generations for improved performance
56+
- **Data integrity**: Don't delete generation 1 files as part of compaction process
57+
- **License handling**: Trim whitespace from license file contents after reading to prevent validation issues
58+
859
## v3.1.0 {date="2025-05-29"}
960
**Core**: revision 482dd8aac580c04f37e8713a8fffae89ae8bc264
1061

‎helper-scripts/generate-release-notes.sh

Lines changed: 135 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,135 @@
1+
#!/bin/bash
2+
3+
# Script to generate release notes for InfluxDB v3.x releases
4+
# Usage: ./generate-release-notes.sh <from_version> <to_version> <repo_path>
5+
6+
set -e
7+
8+
# Default values
9+
REPO_PATH="${3:-/Users/ja/Documents/github/influxdb}"
10+
FROM_VERSION="${1:-v3.1.0}"
11+
TO_VERSION="${2:-v3.2.0}"
12+
13+
# Colors for output
14+
RED='\033[0;31m'
15+
GREEN='\033[0;32m'
16+
YELLOW='\033[0;33m'
17+
BLUE='\033[0;34m'
18+
NC='\033[0m' # No Color
19+
20+
echo -e "${BLUE}Generating release notes for ${TO_VERSION}${NC}"
21+
echo -e "Repository: ${REPO_PATH}"
22+
echo -e "From: ${FROM_VERSION} To: ${TO_VERSION}\n"
23+
24+
# Function to extract PR number from commit message
25+
extract_pr_number() {
26+
echo "$1" | grep -oE '#[0-9]+' | head -1 | sed 's/#//'
27+
}
28+
29+
# Get the release date
30+
RELEASE_DATE=$(git -C "$REPO_PATH" log -1 --format=%ai "$TO_VERSION" | cut -d' ' -f1)
31+
echo -e "${GREEN}Release Date: ${RELEASE_DATE}${NC}\n"
32+
33+
# Collect commits by category
34+
echo -e "${YELLOW}Analyzing commits...${NC}"
35+
36+
# Features
37+
echo -e "\n${GREEN}Features:${NC}"
38+
FEATURES=$(git -C "$REPO_PATH" log --format="%h %s" "${FROM_VERSION}..${TO_VERSION}" | grep -E "^[a-f0-9]+ feat:" | sed 's/^[a-f0-9]* feat: //')
39+
40+
# Fixes
41+
echo -e "\n${GREEN}Bug Fixes:${NC}"
42+
FIXES=$(git -C "$REPO_PATH" log --format="%h %s" "${FROM_VERSION}..${TO_VERSION}" | grep -E "^[a-f0-9]+ fix:" | sed 's/^[a-f0-9]* fix: //')
43+
44+
# Breaking changes
45+
echo -e "\n${GREEN}Breaking Changes:${NC}"
46+
BREAKING=$(git -C "$REPO_PATH" log --format="%h %s" "${FROM_VERSION}..${TO_VERSION}" | grep -iE "^[a-f0-9]+ .*(BREAKING|breaking change)" | sed 's/^[a-f0-9]* //')
47+
48+
# Performance improvements
49+
echo -e "\n${GREEN}Performance:${NC}"
50+
PERF=$(git -C "$REPO_PATH" log --format="%h %s" "${FROM_VERSION}..${TO_VERSION}" | grep -E "^[a-f0-9]+ perf:" | sed 's/^[a-f0-9]* perf: //')
51+
52+
# Generate markdown output
53+
OUTPUT_FILE="release-notes-${TO_VERSION}.md"
54+
cat > "$OUTPUT_FILE" << EOF
55+
## ${TO_VERSION} {date="${RELEASE_DATE}"}
56+
57+
### Features
58+
59+
EOF
60+
61+
# Add features
62+
if [ -n "$FEATURES" ]; then
63+
while IFS= read -r line; do
64+
PR=$(extract_pr_number "$line")
65+
# Clean up the commit message
66+
CLEAN_LINE=$(echo "$line" | sed -E 's/ \(#[0-9]+\)$//')
67+
if [ -n "$PR" ]; then
68+
echo "- $CLEAN_LINE ([#$PR](https://github.com/influxdata/influxdb/pull/$PR))" >> "$OUTPUT_FILE"
69+
else
70+
echo "- $CLEAN_LINE" >> "$OUTPUT_FILE"
71+
fi
72+
done <<< "$FEATURES"
73+
else
74+
echo "- No new features in this release" >> "$OUTPUT_FILE"
75+
fi
76+
77+
# Add bug fixes
78+
cat >> "$OUTPUT_FILE" << EOF
79+
80+
### Bug Fixes
81+
82+
EOF
83+
84+
if [ -n "$FIXES" ]; then
85+
while IFS= read -r line; do
86+
PR=$(extract_pr_number "$line")
87+
CLEAN_LINE=$(echo "$line" | sed -E 's/ \(#[0-9]+\)$//')
88+
if [ -n "$PR" ]; then
89+
echo "- $CLEAN_LINE ([#$PR](https://github.com/influxdata/influxdb/pull/$PR))" >> "$OUTPUT_FILE"
90+
else
91+
echo "- $CLEAN_LINE" >> "$OUTPUT_FILE"
92+
fi
93+
done <<< "$FIXES"
94+
else
95+
echo "- No bug fixes in this release" >> "$OUTPUT_FILE"
96+
fi
97+
98+
# Add breaking changes if any
99+
if [ -n "$BREAKING" ]; then
100+
cat >> "$OUTPUT_FILE" << EOF
101+
102+
### Breaking Changes
103+
104+
EOF
105+
while IFS= read -r line; do
106+
PR=$(extract_pr_number "$line")
107+
CLEAN_LINE=$(echo "$line" | sed -E 's/ \(#[0-9]+\)$//')
108+
if [ -n "$PR" ]; then
109+
echo "- $CLEAN_LINE ([#$PR](https://github.com/influxdata/influxdb/pull/$PR))" >> "$OUTPUT_FILE"
110+
else
111+
echo "- $CLEAN_LINE" >> "$OUTPUT_FILE"
112+
fi
113+
done <<< "$BREAKING"
114+
fi
115+
116+
# Add performance improvements if any
117+
if [ -n "$PERF" ]; then
118+
cat >> "$OUTPUT_FILE" << EOF
119+
120+
### Performance Improvements
121+
122+
EOF
123+
while IFS= read -r line; do
124+
PR=$(extract_pr_number "$line")
125+
CLEAN_LINE=$(echo "$line" | sed -E 's/ \(#[0-9]+\)$//')
126+
if [ -n "$PR" ]; then
127+
echo "- $CLEAN_LINE ([#$PR](https://github.com/influxdata/influxdb/pull/$PR))" >> "$OUTPUT_FILE"
128+
else
129+
echo "- $CLEAN_LINE" >> "$OUTPUT_FILE"
130+
fi
131+
done <<< "$PERF"
132+
fi
133+
134+
echo -e "\n${GREEN}Release notes generated in: ${OUTPUT_FILE}${NC}"
135+
echo -e "${YELLOW}Please review and edit the generated notes before adding to documentation.${NC}"

‎plans/README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Documentation Plans
2+
3+
This directory contains plans for recurring documentation tasks and automation.
4+
5+
## Active Plans
6+
7+
### CLI Documentation Synchronization
8+
- **Location**: `cli-docs-sync/`
9+
- **Purpose**: Keep InfluxDB 3 CLI reference documentation in sync with actual CLI commands
10+
- **Current Version**: `plan-v3.2.0.md`
11+
- **Status**: Ready for execution
12+
13+
### Release Notes Automation
14+
- **Location**: `release-notes-automation/`
15+
- **Purpose**: Automate generation of release notes from git commits
16+
- **Scripts**: Available in `/scripts/generate-release-notes.sh`
17+
18+
## Plan Structure
19+
20+
Each plan directory should contain:
21+
- `plan-[version].md` - The detailed plan
22+
- `execution-log.md` - Track progress and notes
23+
- `templates/` - Reusable templates and patterns
24+
25+
## Usage for Claude
26+
27+
When working with Claude on these plans:
28+
1. Reference the specific plan file: `@plans/[task]/plan-[version].md`
29+
2. Update execution logs as you progress
30+
3. Iterate on plans by creating new versions
31+
4. Use templates for consistency
32+
33+
## Best Practices
34+
35+
- Keep plans versioned by release or iteration
36+
- Document lessons learned in execution logs
37+
- Create reusable templates for recurring patterns
38+
- Link plans to related scripts and automation

‎plans/cli-docs-sync/execution-log.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# CLI Documentation Sync - Execution Log
2+
3+
## v3.2.0 Execution
4+
5+
### Status: Planning Complete ✅
6+
**Date**: 2025-06-26
7+
**Plan**: `plan-v3.2.0.md`
8+
9+
### Phase 1: Analysis (Not Started)
10+
- [ ] Audit existing CLI documentation structure
11+
- [ ] Extract v3.2.0 changes from release notes
12+
- [ ] Generate current CLI help output
13+
14+
### Phase 2: Update Documentation (Not Started)
15+
#### Files to Create:
16+
- [ ] `/content/shared/influxdb3-cli/update/_index.md`
17+
- [ ] `/content/shared/influxdb3-cli/update/database.md`
18+
- [ ] `/content/shared/influxdb3-cli/update/table.md` (Enterprise)
19+
- [ ] `/content/shared/influxdb3-cli/show/license.md` (Enterprise)
20+
21+
#### Files to Update:
22+
- [ ] `/content/shared/influxdb3-cli/create/database.md` (add `--retention-period`)
23+
- [ ] `/content/shared/influxdb3-cli/create/table.md` (add Enterprise `--retention-period`)
24+
- [ ] `/content/shared/influxdb3-cli/show/_index.md` (add license command)
25+
- [ ] `/content/shared/influxdb3-cli/delete/database.md` (review hard delete)
26+
- [ ] `/content/shared/influxdb3-cli/delete/table.md` (review hard delete)
27+
28+
### Phase 3: Automation (Not Started)
29+
- [ ] Create CLI documentation sync script
30+
- [ ] Establish documentation standards
31+
- [ ] Plan CI/CD integration
32+
33+
### Phase 4: Validation (Not Started)
34+
- [ ] Test documented commands
35+
- [ ] Verify completeness
36+
- [ ] Check cross-references
37+
38+
### Notes and Lessons Learned
39+
- Release notes analysis was crucial for identifying specific CLI changes
40+
- Having automation scripts in place (`generate-release-notes.sh`) helped identify features
41+
- Need to distinguish between Core and Enterprise features clearly
42+
43+
### Next Actions
44+
When ready to execute:
45+
1. Reference plan: `@plans/cli-docs-sync/plan-v3.2.0.md`
46+
2. Start with Phase 1 analysis
47+
3. Update this log as progress is made

0 commit comments

Comments
 (0)