-
Notifications
You must be signed in to change notification settings - Fork 25.8k
[DOCS] Add changelog configuration file #140141
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
lcawl
wants to merge
7
commits into
elastic:main
Choose a base branch
from
lcawl:changelog-config
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from 4 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
1d58485
[DOCS] Add changelog configuration file
lcawl 3a41a15
Fix changelog.yml
lcawl 67a9d93
Add more exclusions
lcawl 16729fc
Fix add_blockers and render_blockers
lcawl b69e0b2
Update docs/changelog.yml
lcawl 7d50dee
Merge branch 'main' into changelog-config
lcawl acdd153
Uncomment all blockers
lcawl File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,283 @@ | ||
| # Changelog Configuration | ||
| # This file configures the valid values for changelog fields. | ||
| # Place this file as `changelog.yml` in the `docs/` directory | ||
|
|
||
| # Available products (optional - if not specified, all valid products are allowed) | ||
| available_products: | ||
| - elasticsearch | ||
| - cloud-serverless | ||
| # Add more products as needed | ||
|
|
||
| # Available types for changelog entries (optional - if not specified, all valid types are allowed) | ||
| # available_types: | ||
| # - breaking-change | ||
| # - bug-fix | ||
| # - deprecation | ||
| # - docs | ||
| # - enhancement | ||
| # - feature | ||
| # - known-issue | ||
| # - regression | ||
| # - security | ||
| # - other | ||
|
|
||
| # GitHub label mappings (optional - used when --pr option is specified) | ||
| # Maps GitHub PR labels to changelog type values | ||
| # When a PR has a label that matches a key, the corresponding type value is used | ||
| label_to_type: | ||
| ">breaking": breaking-change | ||
| ">breaking-java": breaking-change | ||
| ">bug": bug-fix | ||
| ">deprecation": deprecation | ||
| ">docs": docs | ||
| "documentation": docs | ||
| "release_note:enhancement": enhancement | ||
| ">enhancement": enhancement | ||
| ">feature": feature | ||
| # "type:known": known-issue | ||
| ">regression": regression | ||
| # "type:security": security | ||
| # "type:other": other | ||
|
|
||
| # Available subtypes for breaking changes (optional - if not specified, all valid subtypes are allowed) | ||
| # available_subtypes: | ||
| # - api | ||
| # - behavioral | ||
| # - configuration | ||
| # - dependency | ||
| # - subscription | ||
| # - plugin | ||
| # - security | ||
| # - other | ||
|
|
||
| # Available lifecycle values (optional - if not specified, all valid lifecycle values are allowed) | ||
| # available_lifecycles: | ||
| # - preview | ||
| # - beta | ||
| # - ga | ||
|
|
||
| # Available areas (optional - if not specified, all areas are allowed) | ||
| available_areas: | ||
| - Aggregations | ||
| - Allocation | ||
| - Analysis | ||
| - Application | ||
| - Audit | ||
| - Authentication | ||
| - Authorization | ||
| - Autoscaling | ||
| - CAT APIs | ||
| - CCR | ||
| - CCS | ||
| - CRUD | ||
| - Client | ||
| - Cluster Coordination | ||
| - Codec | ||
| - Data streams | ||
| - DLM | ||
| - Discovery-Plugins | ||
| - Distributed | ||
| - Downsampling | ||
| - Engine | ||
| - EQL | ||
| - ES|QL | ||
| - Experiences | ||
| - Extract&Transform | ||
| - Features | ||
| - FIPS | ||
| - Geo | ||
| - Graph | ||
| - Health | ||
| - Highlighting | ||
| - ILM+SLM | ||
| - IdentityProvider | ||
| - Indices APIs | ||
| - Inference | ||
| - Infra/CLI | ||
| - Infra/Circuit Breakers | ||
| - Infra/Core | ||
| - Infra/Entitlements | ||
| - Infra/Logging | ||
| - Infra/Metrics | ||
| - Infra/Node Lifecycle | ||
| - Infra/Plugins | ||
| - Infra/REST API | ||
| - Infra/Resiliency | ||
| - Infra/Scripting | ||
| - Infra/Settings | ||
| - Infra/Transport API | ||
| - Ingest | ||
| - Ingest Node | ||
| - Java High Level REST Client | ||
| - Java Low Level REST Client | ||
| - License | ||
| - Logging | ||
| - Logs | ||
| - Machine Learning | ||
| - Mapping | ||
| - Monitoring | ||
| - Network | ||
| - Packaging | ||
| - Percolator | ||
| - Performance | ||
| - Query Languages | ||
| - Ranking | ||
| - Recovery | ||
| - Reindex | ||
| - Relevance | ||
| - Rollup | ||
| - SQL | ||
| - Search | ||
| - Searchable Snapshots | ||
| - Security | ||
| - Snapshot/Restore | ||
| - Stats | ||
| - Store | ||
| - Suggesters | ||
| - Task Management | ||
| - TLS | ||
| - Transform | ||
| - TSDB | ||
| - Vector Search | ||
| - Watcher | ||
| # Add more areas as needed | ||
|
|
||
| # Maps GitHub PR labels to changelog area values | ||
| # Multiple labels can map to the same area, and a single label can map to multiple areas (comma-separated) | ||
| label_to_areas: | ||
| ":Analytics/Aggregations": Aggregations | ||
| ":Distributed Coordination/Allocation": Allocation | ||
| ":Search Relevance/Analysis": Analysis | ||
| ":EnterpriseSearch/Application": Application | ||
| ":Security/Audit": Audit | ||
| ":Security/Authentication": Authentication | ||
| ":Security/Authorization": Authorization | ||
| ":Distributed Coordination/Autoscaling": Autoscaling | ||
| ":Data Management/CAT APIs": CAT APIs" | ||
| ":Distributed Indexing/CCR": CCR | ||
| ":Search Foundations/CCS": CCS | ||
| ":Distributed Indexing/CRUD": CRUD | ||
| ":Security/Client": Client | ||
| ":Distributed Coordination/Cluster Coordination": Cluster Coordination | ||
| ":StorageEngine/Codec": Codec | ||
| ":Data Management/Data streams": "Data streams" | ||
| ":Data Management/DLM": DLM | ||
| ":Distributed Coordination/Discovery-Plugins": Discovery-Plugins | ||
| ":Distributed Indexing/Distributed": Distributed | ||
| ":StorageEngine/Downsampling": Downsampling | ||
| ":Distributed Indexing/Engine": Engine | ||
| ":Search Relevance/ES|QL": "ES|QL" | ||
| ":StorageEngine/ES|QL": "ES|QL" | ||
| ":ml/ES|QL": "ES|QL" | ||
| ":Analytics/ES|QL": "ES|QL" | ||
| ":SearchOrg/Experiences": Experiences | ||
| ":SearchOrg/Extract&Transform": "Extract&Transform" | ||
| ":Security/FIPS": FIPS | ||
| ":Analytics/Geo": Geo | ||
| ":Data Management/Health": Health | ||
| ":Search Relevance/Highlighting": Highlighting | ||
| ":Data Management/ILM+SLM": ILM+SLM | ||
| ":Security/IdentityProvider": IdentityProvider | ||
| ":Data Management/Indices APIs": "Indices APIs" | ||
| ":SearchOrg/Inference": Inference | ||
| ":Core/Infra/CLI": "Infra/CLI" | ||
| ":Core/Infra/Circuit Breakers": "Infra/Circuit Breakers" | ||
| ":Core/Infra/Core": "Infra/Core" | ||
| ":Core/Infra/Entitlements": "Infra/Entitlements" | ||
| ":Core/Infra/Logging": "Infra/Logging" | ||
| ":Core/Infra/Metrics": "Infra/Metrics" | ||
| ":Core/Infra/Node Lifecycle": "Infra/Node Lifecycle" | ||
| ":Core/Infra/Plugins": "Infra/Plugins" | ||
| ":Core/Infra/REST API": "Infra/REST API" | ||
| ":Core/Infra/Resiliency": "Infra/Resiliency" | ||
| ":Core/Infra/Scripting": "Infra/Scripting" | ||
| ":Core/Infra/Settings": "Infra/Settings" | ||
| ":Core/Infra/Transport API": "Infra/Transport API" | ||
| ":Data Management/Ingest Node": "Ingest Node" | ||
| ":Clients/Java High Level REST Client": "Java High Level REST Client" | ||
| ":Clients/Java Low Level REST Client": "Java Low Level REST Client" | ||
| ":Security/License": License | ||
| ":StorageEngine/Logs": Logs | ||
| "StorageEngine/Logs": Logs | ||
| ":ml": "Machine Learning" | ||
| ":StorageEngine/Mapping": Mapping | ||
| ":Search Foundations/Mapping": Mapping | ||
| ":Data Management/Monitoring": Monitoring | ||
| ":Distributed Coordination/Network": Network | ||
| ":Delivery/Packaging": Packaging | ||
| ":Search Relevance/Percolator": Percolator | ||
| ":Performance": Performance | ||
| ":Query Languages/EQL": "Query Languages,EQL" | ||
| ":Query Languages/SQL": "Query Languages,SQL" | ||
| ":Search Relevance/Ranking": Ranking | ||
| ":Distributed Indexing/Recovery": Recovery | ||
| ":Distributed Indexing/Reindex": Reindex | ||
| ":Search Relevance/Search": Relevance | ||
| ":StorageEngine/Rollup": Rollup | ||
| ":Search/Search": Search | ||
| ":Distributed Indexing/Searchable Snapshots": Searchable Snapshots | ||
| ":Security/Security": Security | ||
| ":Distributed Coordination/Snapshot/Restore": Snapshot/Restore | ||
| ":Data Management/Stats": Stats | ||
| ":Distributed Indexing/Store": Store | ||
| ":Search Relevance/Suggesters": Suggesters | ||
| ":Distributed Coordination/Task Management": Task Management | ||
| ":Security/TLS": TLS | ||
| ":ml/Transform": Transform | ||
| ":StorageEngine/TSDB": TSDB | ||
| ":Search Relevance/Vectors": "Vector Search" | ||
| ":Data Management/Watcher": Watcher | ||
| # TBD: Features | ||
| # "TBD": Graph | ||
| # TBD: Ingest | ||
| # "TBD": Logging | ||
|
|
||
| # Product-specific label blockers (optional) | ||
| # Maps product IDs to lists of labels that prevent changelog creation for that product | ||
| # If you run the changelog add command with the --prs option and a PR has any of these labels, the changelog is not created | ||
| # add_blockers: | ||
| # elasticsearch,cloud-serverless: | ||
| # - ">non-issue" | ||
| # - ">test" | ||
| # - ">refactoring" | ||
| # - ":Delivery/Build" | ||
| # - ":Delivery/Tooling" | ||
|
|
||
| # render_blockers: | ||
| # cloud-serverless: | ||
| # areas: | ||
| # - Allocation | ||
| # - Audit | ||
| # - Authentication | ||
| # - Autoscaling | ||
| # - CCR | ||
| # - CCS | ||
| # - "Cluster Coordination" | ||
| # - Codec | ||
| # - "Discovery-Plugins" | ||
| # - Engine | ||
| # - FIPS | ||
| # - Health | ||
| # - "ILM+SLM" | ||
| # - "IdentityProvider" | ||
| # - "Infra/CLI" | ||
| # - "Circuit Breakers" | ||
| # - "Infra/Core" | ||
| # - "Infra/Entitlements" | ||
| # - "Infra/Logging" | ||
| # - "Infra/Metrics" | ||
| # - "Infra/Node Lifecycle" | ||
| # - "Infra/Plugins" | ||
| # - "Infra/Transport API" | ||
| # - License | ||
| # - Monitoring | ||
| # - Packaging | ||
| # - Searchable Snapshots | ||
| # - "Snapshot/Restore" | ||
| # - Stats | ||
| # - Watcher | ||
| # types: | ||
| # - docs | ||
| # elasticsearch: | ||
| # types: | ||
| # - docs | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.