Add explanation of the extension graduation process #1163
Merged
Conversation
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
Signed-off-by: Paul Balogh <javaducky@gmail.com>
javaducky
force-pushed
the
paul/extn-graduation
branch
from
c2acde5 to
2e8540e
Compare
|
There's a version of the docs published here: https://mdr-ci.staging.k6.io/docs/refs/pull/1163/merge It will be deleted automatically in 30 days. |
ppcano
approved these changes
May 8, 2023
This comment was marked as duplicate.
This comment was marked as duplicate.
Sorry, something went wrong.
src/data/markdown/docs/07 extensions/02 Explanations/030-extension-graduation.md
Show resolved
Hide resolved
src/data/markdown/docs/07 extensions/02 Explanations/030-extension-graduation.md
Show resolved
Hide resolved
src/data/markdown/docs/07 extensions/02 Explanations/030-extension-graduation.md
Show resolved
Hide resolved
|
|
||
| The three phases which a _core-bound_ extension will go through include: | ||
|
|
||
| **_extension_ -> _experimental module_ -> _core module_** |
There was a problem hiding this comment.
Suggested change
| **_extension_ -> _experimental module_ -> _core module_** | |
| |
Not sure, this seems like a hacky way to make a tab.
Maybe just make it an ordered list:
1. **Extension.** Requiring xk6.
2. **Experimental module.** Imported into the k6 core as a Go module.
3. **Core module.** Part of k6 core.
Alternatively, you could use a diagram, like with the options order of precedence: https://k6.io/docs/static/cd2ffc633dd58c67e276922851216ab9/0e253/order-of-precedence.png
Comment on lines
+17
to
+25
| Most of the extensions in the k6 ecosystem will remain an _extension_ requiring using [xk6](https://github.com/grafana/xk6) to incorporate the custom functionality. | ||
| These extensions will be a mix of Grafana- and community-provided features and _may_ be included in the [Extensions Registry](/extensions/get-started/explore/). | ||
|
|
||
| <Blockquote mod="note" title=""> | ||
|
|
||
| Only Grafana-owned extensions may progress beyond the _extension_ phase to become _experimental_ or _core modules_. | ||
|
|
||
| </Blockquote> | ||
|
|
There was a problem hiding this comment.
Suggested change
| Most of the extensions in the k6 ecosystem will remain an _extension_ requiring using [xk6](https://github.com/grafana/xk6) to incorporate the custom functionality. | |
| These extensions will be a mix of Grafana- and community-provided features and _may_ be included in the [Extensions Registry](/extensions/get-started/explore/). | |
| <Blockquote mod="note" title=""> | |
| Only Grafana-owned extensions may progress beyond the _extension_ phase to become _experimental_ or _core modules_. | |
| </Blockquote> | |
| Most extensions in the k6 ecosystem remain _extensions_ requiring [xk6](https://github.com/grafana/xk6) to incorporate the custom functionality. | |
| These extensions might be provided by Grafana or by the community, and _may_ be included in the [Extensions Registry](/extensions/get-started/explore/). | |
| <Blockquote mod="note" title=""> | |
| Only Grafana-owned extensions can progress beyond the _extension_ phase to become _experimental_ or _core modules_. | |
| </Blockquote> | |
|
|
||
| ### Experimental Module | ||
| This phase is the first exposure to core k6. | ||
| The extension is still maintained outside the core of k6 but imported as a Go module, no longer requiring using xk6. |
There was a problem hiding this comment.
Suggested change
| The extension is still maintained outside the core of k6 but imported as a Go module, no longer requiring using xk6. | |
| The extension is still maintained outside the core of k6 but imported as a Go module, no longer requiring xk6. |
| The extension is still maintained outside the core of k6 but imported as a Go module, no longer requiring using xk6. | ||
|
|
||
| There should be a reasonably high degree of quality and stability at this point. | ||
| This phase will allow adoption by a broader subset of OSS and cloud users while getting actionable feedback about the user experience. |
There was a problem hiding this comment.
Suggested change
| This phase will allow adoption by a broader subset of OSS and cloud users while getting actionable feedback about the user experience. | |
| This phase makes the feature accessible to more users, which in turn gives k6 developers more chances to receive feedback. |
Comment on lines
+38
to
+40
| The extension code will be in the main k6 repository, with the old extension repository archived. | ||
| Options from the _experimental module_ phase will be deprecated and removed after two k6 releases. | ||
| This time frame should provide ample time for users to upgrade scripts for the new usage. |
There was a problem hiding this comment.
Suggested change
| The extension code will be in the main k6 repository, with the old extension repository archived. | |
| Options from the _experimental module_ phase will be deprecated and removed after two k6 releases. | |
| This time frame should provide ample time for users to upgrade scripts for the new usage. | |
| The module code is in the main k6 repository, with the old extension repository archived. | |
| Options from the _experimental module_ phase are deprecated and removed after two k6 releases, | |
| providing time for users to upgrade scripts for the new module. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
In the spirit of the internal discussion proposed by @na-- for explaining the process of graduating extensions to built-in core modules.