Skip to content

Add experimental lifecycle to changelog tooling #3311

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.

Sign up for GitHub

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

Open
lcawl wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add experimental lifecycle to changelog tooling #3311

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions config/changelog.example.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ lifecycles:
- preview
- beta
- ga
- experimental

# Pivot configuration for types, subtypes, and areas with label mappings.
# By default we render changelogs grouped by type > subtype > area.
Expand Down
11 changes: 6 additions & 5 deletions docs/contribute/configure-changelogs-ref.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,11 +211,12 @@ Specifies the allowed lifecycle values for your changelogs.
:::{table}
:widths: description

| Value | Description |
| --------- | --------------------------------- |
| `preview` | Technical preview or early access |
| `beta` | Beta release |
| `ga` | General availability |
| Value | Description |
| -------------- | --------------------------------- |
| `preview` | Tech previews are time-boxed evaluations to help us gather early feedback from customers on key upcoming features. |
| `beta` | Beta features are no longer supported but some products might have beta releases. |
| `ga` | General availability features are stable, scalable, and production-ready. |
| `experimental` | The experimental phase exists to enable rapid iteration on new features. |

:::

Expand Down
3 changes: 2 additions & 1 deletion src/Elastic.Documentation.Configuration/Changelog/ChangelogConfiguration.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,8 @@ public record ChangelogConfiguration
[
Lifecycle.Preview,
Lifecycle.Beta,
Lifecycle.Ga
Lifecycle.Ga,
Lifecycle.Experimental
];

/// <summary>
Expand Down
10 changes: 7 additions & 3 deletions src/Elastic.Documentation/Lifecycle.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,19 @@ namespace Elastic.Documentation;
[EnumExtensions]
public enum Lifecycle
{
/// <summary>A technical preview of a feature or enhancement.</summary>
/// <summary>Tech Previews are time-boxed evaluations to help us gather early feedback from customers on key upcoming features.</summary>
[Display(Name = "preview")]
Preview,

/// <summary>A beta release of a feature or enhancement.</summary>
[Display(Name = "beta")]
Beta,

/// <summary>A generally available release of a feature or enhancement.</summary>
/// <summary>Generally available features are stable, scalable, and production-ready.</summary>
[Display(Name = "ga")]
Ga
Ga,

/// <summary>The experimental phase exists to enable rapid iteration on new features.</summary>
[Display(Name = "experimental")]
Experimental
}
3 changes: 1 addition & 2 deletions tests/Elastic.Changelog.Tests/Changelogs/ChangelogConfigurationTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@
using Elastic.Documentation;
using Elastic.Documentation.Configuration;
using Elastic.Documentation.Configuration.Changelog;
using Elastic.Documentation.Configuration.Changelog;
using Elastic.Documentation.Configuration.Changelog;
using Elastic.Documentation.Diagnostics;
using Elastic.Documentation.ReleaseNotes;

Expand Down Expand Up @@ -142,6 +140,7 @@ public async Task LoadChangelogConfiguration_WithoutAvailableLifecycles_UsesDefa
config.Lifecycles.Should().Contain(Lifecycle.Preview);
config.Lifecycles.Should().Contain(Lifecycle.Beta);
config.Lifecycles.Should().Contain(Lifecycle.Ga);
config.Lifecycles.Should().Contain(Lifecycle.Experimental);
}
finally
{
Expand Down
1 change: 1 addition & 0 deletions tests/Elastic.Markdown.Tests/Directives/ChangelogConfigTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -379,6 +379,7 @@ public ChangelogConfigEmptyBlockTests(ITestOutputHelper output) : base(output,
- preview
- beta
- ga
- experimental
"""));
}

Expand Down
Loading