diff --git a/docs/changelog.yml b/docs/changelog.yml new file mode 100644 index 000000000..22c7b4835 --- /dev/null +++ b/docs/changelog.yml @@ -0,0 +1,130 @@ +# Changelog Configuration +# This file configures the valid values for changelog fields using the pivot structure. +# Place this file as `changelog.yml` in the `docs/` directory + +# Products configuration (optional) +# If not specified, all products from products.yml are allowed +products: + # List of available product IDs (empty = all from products.yml) + available: + - logstash + # Default products when --products not specified + default: + - product: logstash + lifecycle: ga + +# Extraction configuration +# Controls automatic extraction of information from PR descriptions +extract: + # Auto-extract release notes from PR descriptions (default: true) + # Can be overridden by CLI --no-extract-release-notes + release_notes: true + # Auto-extract issues from PR body (default: true) + # Looks for patterns like "Fixes #123", "Closes #456", etc. + issues: true + +# Available lifecycle values (strongly typed: preview, beta, ga) +lifecycles: + - preview + - beta + - ga + +# Pivot configuration for types, subtypes, and areas with label mappings. +# By default we render entries grouped by type > subtype > area. +# NOTE: subtype and area are optional and either may be omitted. +# Labels are specified in a "label -> value" format +pivot: + # Type definitions with optional labels + # At a minimum, feature, bug-fix, and breaking-change must be configured. + # Keys are type names, values can be: + # - simple string: comma-separated label list (e.g., ">bug, >fix") + # - empty/null: no labels for this type + # - object: { labels: "...", subtypes: {...} } for breaking-change type only + types: + # Complex object form with subtypes (ONLY allowed for breaking-change) + # Subtypes help categorize breaking changes by their nature + breaking-change: + labels: "breaking change" + # subtypes: + # api: ">api-breaking" + # behavioral: ">behavioral-breaking" + # configuration: ">config-breaking" + # dependency: ">dependency-breaking" + # subscription: ">subscription-breaking" + # plugin: ">plugin-breaking" + # security: ">security-breaking" + # other: + # Simple string form: labels as comma-separated string + bug-fix: "bug" + # deprecation: "deprecation" + feature: + enhancement: "enhancement" + docs: "docs" + known-issue: + other: + regression: "performance-regression" + security: + + # Area definitions with labels + # Keys are area display names, values are label strings + # Multiple labels can be comma-separated + # areas: + # Example mappings - customize based on your label naming conventions + # Autoscaling: ":Distributed Coordination/Autoscaling" + # Search: ":Search/Search" + # Security: ":Security/Security" + # Watcher: ":Data Management/Watcher" + +# Block configuration - combined create and publish blockers +# block: + # Global labels that block changelog creation for all products (comma-separated string) + # create: ">non-issue, >test" + + # Block changelog entries from publishing based on entry type or area + # publish: + # types: + # - deprecation + # - known-issue + # areas: + # - "Internal" + + # Product-specific overrides (override global blockers, don't merge) + # Dictionary key can be a single product ID or comma-separated product IDs + # product: + # Example: Block these labels for elasticsearch and kibana + # 'elasticsearch, kibana': + # create: ">test" + # publish: + # types: + # - docs + # Example: Block ILM label for cloud-serverless + # 'cloud-serverless': + # create: "ILM" + # publish: + # areas: + # - "ILM" + +# Bundle configuration (profiles and defaults) +bundle: + # Input directory containing changelog YAML files + directory: docs/changelog + # Output directory for bundled changelog files + output_directory: docs/releases + # Whether to resolve (copy contents) by default + resolve: true + + # Named bundle profiles for different release scenarios + # profiles: + # Example: Elasticsearch release profile + # elasticsearch-release: + # products: "elasticsearch {version} {lifecycle}" + # output: "elasticsearch-{version}.yaml" + + # Example: Serverless release profile + # serverless-release: + # products: "cloud-serverless {version} *" + # output: "serverless-{version}.yaml" + # # Feature IDs to hide when bundling with this profile + # hide_features: + # - feature-flag-1 + # - feature-flag-2 diff --git a/docs/changelog/1228.yaml b/docs/changelog/1228.yaml new file mode 100644 index 000000000..d3c29ed4d --- /dev/null +++ b/docs/changelog/1228.yaml @@ -0,0 +1,92 @@ +##### Required fields ##### + +# title: +# A required string that is a short, user-facing headline. +# (Max 80 characters) + +# type: +# A required string that contains the type of change +# It can be one of: +# - breaking-change +# - bug-fix +# - feature +# - enhancement +# - docs +# - known-issue +# - other +# - regression +# - security + +# products: +# A required array of objects that denote the affected products +# Each product object contains: +# +# - product: +# A required string with a valid product ID. +# Valid values are defined in https://github.com/elastic/docs-builder/blob/main/config/products.yml +# +# target: +# An optional string with the target version or date. +# +# lifecycle: +# An optional string for new features or enhancements that have a specific availability. +# It can be one of: +# - preview +# - beta +# - ga + +##### Optional fields ##### + +# action: +# An optional string that describes what users must do to mitigate +# the impact of a breaking change or known issue. + +# areas: +# An optional array of strings that denotes the parts/components/services +# of the product that are affected. + +# description: +# An optional string that provides additional information. +# (Max 600 characters). + +# feature-id: +# An optional string to associate a feature or enhanceent with a +# unique feature flag. + +# highlight: +# An optional boolean for items that should be included in release +# highlights or the UI to draw user attention. + +# impact: +# An optional string that describes how the user's environment is +# affected by a breaking change or known issue. + +# issues: +# An optional array of strings that contain the issues that are +# relevant to the PR. + +# pr: +# An optional string that contains the pull request number. + +# subtype: +# An optional string that applies only to breaking changes. +# It can be one of: +# - api +# - behavioral +# - configuration +# - dependency +# - subscription +# - plugin +# - security +# - other + +pr: https://github.com/logstash-plugins/logstash-output-elasticsearch/pull/1228 +issues: +- https://github.com/logstash-plugins/logstash-output-elasticsearch/issues/1225 +type: other +products: +- product: logstash + target: 9.3.0 +areas: +- Elasticsearch Output +title: Add drop_error_types config option to not retry after certain error types diff --git a/docs/changelog/1232.yaml b/docs/changelog/1232.yaml new file mode 100644 index 000000000..091d07fea --- /dev/null +++ b/docs/changelog/1232.yaml @@ -0,0 +1,90 @@ +##### Required fields ##### + +# title: +# A required string that is a short, user-facing headline. +# (Max 80 characters) + +# type: +# A required string that contains the type of change +# It can be one of: +# - breaking-change +# - bug-fix +# - feature +# - enhancement +# - docs +# - known-issue +# - other +# - regression +# - security + +# products: +# A required array of objects that denote the affected products +# Each product object contains: +# +# - product: +# A required string with a valid product ID. +# Valid values are defined in https://github.com/elastic/docs-builder/blob/main/config/products.yml +# +# target: +# An optional string with the target version or date. +# +# lifecycle: +# An optional string for new features or enhancements that have a specific availability. +# It can be one of: +# - preview +# - beta +# - ga + +##### Optional fields ##### + +# action: +# An optional string that describes what users must do to mitigate +# the impact of a breaking change or known issue. + +# areas: +# An optional array of strings that denotes the parts/components/services +# of the product that are affected. + +# description: +# An optional string that provides additional information. +# (Max 600 characters). + +# feature-id: +# An optional string to associate a feature or enhanceent with a +# unique feature flag. + +# highlight: +# An optional boolean for items that should be included in release +# highlights or the UI to draw user attention. + +# impact: +# An optional string that describes how the user's environment is +# affected by a breaking change or known issue. + +# issues: +# An optional array of strings that contain the issues that are +# relevant to the PR. + +# pr: +# An optional string that contains the pull request number. + +# subtype: +# An optional string that applies only to breaking changes. +# It can be one of: +# - api +# - behavioral +# - configuration +# - dependency +# - subscription +# - plugin +# - security +# - other + +pr: https://github.com/logstash-plugins/logstash-output-elasticsearch/pull/1232 +type: other +products: +- product: logstash + target: 9.3.0 +areas: +- Elasticsearch Output +title: Remove duplicated deprecation log entry