-
Notifications
You must be signed in to change notification settings - Fork 244
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
docs: publish jsii@1.x and jsii-rosetta@1.x maintenance announcement #4067
Conversation
Since we have released jsii@5.0.x and jsii-rosetta@5.0.x and have been using it for a while to build & release the AWS CDK, without any significant surprise so far, we are moving forward with announcing the placement of jsii@1.x and jsii-rosetta@1.x into maintenance, and are actively encouraging customers to migrate to the new release lines.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A couple of typos with a couple of non-blocking suggestions.
We have recently released `jsii@5.0.0` and `jsii-rosetta@5.0.0`, built on the TypeScript `5.0.x` compiler, allowing | ||
package maintainers to migrate to a more modern TypeScript language version than 3.9 (which the `1.x` release line is | ||
built on). This change was designed in [RFC-374], and removes the need for developers to pin some of their dependencies | ||
to releases still compatible with TypeScript 3.9 without necessarily requiring their dependents to do the same at the | ||
same time. Upgrading your `jsii` and `jsii-rosetta` dependencies to `v5.0.x` is transparent to your users. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We have recently released `jsii@5.0.0` and `jsii-rosetta@5.0.0`, built on the TypeScript `5.0.x` compiler, allowing | |
package maintainers to migrate to a more modern TypeScript language version than 3.9 (which the `1.x` release line is | |
built on). This change was designed in [RFC-374], and removes the need for developers to pin some of their dependencies | |
to releases still compatible with TypeScript 3.9 without necessarily requiring their dependents to do the same at the | |
same time. Upgrading your `jsii` and `jsii-rosetta` dependencies to `v5.0.x` is transparent to your users. | |
We have recently released `jsii@5.0.0` and `jsii-rosetta@5.0.0`, built on the TypeScript `5.0.x` compiler. Package maintainers can migrate past the 3.9 TypeScript language version (which the `1.x` release line is | |
built on). This change was designed in [RFC-374]. It removes the need for developers to pin some of their dependencies | |
to releases still compatible with TypeScript 3.9, without necessarily requiring their dependents to do the same at the | |
same time. Upgrading your `jsii` and `jsii-rosetta` dependencies to `v5.0.x` is transparent to your users. |
|
||
### Can my app have dependencies built by different `jsii` release lines? | ||
|
||
The `jsii` compiler and `jsii-rosetta` versions used to build a library has no material impact on the runtime artifacts. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The `jsii` compiler and `jsii-rosetta` versions used to build a library has no material impact on the runtime artifacts. | |
The `jsii` compiler and `jsii-rosetta` versions used to build a library which has no material impact on the runtime artifacts. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this changes the meaning of the sentence (which is there to say your choice of compilers doesn't affect your consumers).
| [jsii-config] | `1.x` | Experimental | Interactive tool for generating jsii configuration | | ||
| [jsii-release] | `1.x` | Community | Publishes jsii modules to all supported package managers | | ||
| [jsii-srcmak] | `1.x` | Community | Generates relocatable source code in jsii languages from typescript | | ||
| [jsii-docgen] | `1.x` | Community | Generates markdown API documentation for jsii modules | | ||
|
||
??? question "Stability Definitions" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
??? question "Stability Definitions" | |
Still under review: "Stability Definitions" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The ??? question
is a special markdown admonition that creates a collapsible block titled "Stability Definitions" that has a question mark icon :)
See: https://python-markdown.github.io/extensions/admonition/
|
||
??? question "Stability Definitions" | ||
- **Stable**: Projects that comply with the [Semantic Versioning][semver] specification, and will hence not change | ||
behavior or receive other breaking changes across minor and patch version bumps. | ||
- **GA**: Projects that are deemed *Generally Available* and for which customers can expect full support, including |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- **GA**: Projects that are deemed *Generally Available* and for which customers can expect full support, including | |
- **GA**: Projects that are deemed *Generally Available* and for which customers can expect full support, including |
The format looks strange when in preview (not a list). I am guessing it's a missing new line here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yea... this is the specific markdown flavor that mkdoc uses... It's mostly compatible with GFM, but there's some minute differences... I did run a preview with mkdoc serve
locally and it looked all dandy... This is a case where you can't fully trust the GitHub render preview.
Co-authored-by: Naumel <104374999+Naumel@users.noreply.github.com>
Thank you for contributing! ❤️ I will now look into making sure the PR is up-to-date, then proceed to try and merge it! |
Merging (with squash)... |
Since we have released
jsii@5.0.x
andjsii-rosetta@5.0.x
and have been using it for a while to build & release the AWS CDK, without any significant surprise so far, we are moving forward with announcing the placement ofjsii@1.x
andjsii-rosetta@1.x
into maintenance, and are actively encouraging customers to migrate to the new release lines.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.