|
| 1 | +# Changelog Configuration |
| 2 | +# This file configures the valid values for changelog fields. |
| 3 | +# Place this file as `changelog.yml` in the `docs/` directory |
| 4 | + |
| 5 | +# Available types for changelog entries |
| 6 | +available_types: |
| 7 | + - breaking-change |
| 8 | + - bug-fix |
| 9 | + - deprecation |
| 10 | + - docs |
| 11 | + - enhancement |
| 12 | + - feature |
| 13 | + - known-issue |
| 14 | + - other |
| 15 | + - regression |
| 16 | + - security |
| 17 | + |
| 18 | +# Available subtypes for breaking changes |
| 19 | +available_subtypes: |
| 20 | + - api |
| 21 | + - behavioral |
| 22 | + - configuration |
| 23 | + - dependency |
| 24 | + - subscription |
| 25 | + - plugin |
| 26 | + - security |
| 27 | + - other |
| 28 | + |
| 29 | +# Available lifecycle values |
| 30 | +available_lifecycles: |
| 31 | + - preview |
| 32 | + - beta |
| 33 | + - ga |
| 34 | + |
| 35 | +# Available areas (optional - if not specified, all areas are allowed) |
| 36 | +available_areas: |
| 37 | + # - Autoscaling |
| 38 | + # - Search |
| 39 | + # - Security |
| 40 | + # - Watcher |
| 41 | + # Add more areas as needed |
| 42 | + |
| 43 | +# Available products (optional - if not specified, all products are allowed) |
| 44 | +available_products: |
| 45 | + # - elasticsearch |
| 46 | + # - kibana |
| 47 | + # - apm |
| 48 | + # - beats |
| 49 | + # - elastic-agent |
| 50 | + # - fleet |
| 51 | + # - cloud-hosted |
| 52 | + # - cloud-serverless |
| 53 | + # - cloud-enterprise |
| 54 | + # Add more products as needed |
| 55 | + |
| 56 | +# GitHub label mappings (optional - used when --pr option is specified) |
| 57 | +# Maps GitHub PR labels to changelog type values |
| 58 | +# When a PR has a label that matches a key, the corresponding type value is used |
| 59 | +label_to_type: |
| 60 | + # Example mappings - customize based on your label naming conventions |
| 61 | + # ">breaking": breaking-change |
| 62 | + # ">bug": bug-fix |
| 63 | + # ">docs": docs |
| 64 | + # ">enhancement": enhancement |
| 65 | + # ">feature": feature |
| 66 | + |
| 67 | +# Maps GitHub PR labels to changelog area values |
| 68 | +# Multiple labels can map to the same area, and a single label can map to multiple areas (comma-separated) |
| 69 | +label_to_areas: |
| 70 | + # Example mappings - customize based on your label naming conventions |
| 71 | + # ":Distributed Coordination/Autoscaling": Autoscaling |
| 72 | + # ":Search/Search": Search |
| 73 | + # ":Security/Security": Security |
| 74 | + # ":Data Management/Watcher": Watcher |
| 75 | + # "area:multiple": "Search, Security" # Multiple areas comma-separated |
| 76 | + |
| 77 | +# Product-specific label blockers (optional) |
| 78 | +# Maps product IDs to lists of pull request labels that prevent changelog creation for that product |
| 79 | +# If you run the changelog add command with the --prs option and a PR has any of these labels, the changelog is not created |
| 80 | +# Product IDs can be comma-separated to share the same list of labels across multiple products |
| 81 | +add_blockers: |
| 82 | + # Example: Skip changelog creation for elasticsearch product when PR has these labels |
| 83 | + # elasticsearch: |
| 84 | + # - ">non-issue" |
| 85 | + # - ">test" |
| 86 | + # - ">refactoring" |
| 87 | + # Example: Share the same blockers across multiple products using comma-separated product IDs |
| 88 | + # elasticsearch, cloud-serverless: |
| 89 | + # - ">non-issue" |
| 90 | + |
| 91 | +# Render blockers (optional - used by the "docs-builder changelog render" command) |
| 92 | +# Changelogs matching the specified products and areas/types will be commented out in rendered output files |
| 93 | +# Dictionary key can be a single product ID or comma-separated product IDs (e.g., "elasticsearch, cloud-serverless") |
| 94 | +# Dictionary value contains areas and/or types that should be blocked for those products |
| 95 | +render_blockers: |
| 96 | + # Multiple products (comma-separated) with areas and types that should be blocked |
| 97 | + "cloud-hosted, cloud-serverless": |
| 98 | + areas: # List of area values that should be blocked (commented out) during render |
| 99 | + - Autoscaling |
| 100 | + - Watcher |
| 101 | + types: # List of type values that should be blocked (commented out) during render |
| 102 | + - docs |
| 103 | + # Single product with areas that should be blocked |
| 104 | + elasticsearch: |
| 105 | + areas: |
| 106 | + - Security |
0 commit comments