feat: Register module-level stability #515
Merged
Conversation
This file contains 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
Adds the necessary code to detect and forward module-level stability indications to the assembly, so it can be used by downstream languages. This effectively removes the `markdown` attribute from the `Assembly` in favor of using the `docs` attribute. If a stability indication, a specific badge _must_ be present in the accompanying `README.md` file (which as a consequence is required to exist), to denote the maturity of the module in user-visible documentation, too. The tool prescribes what the badge must look like. Also, renders a `package-info.json` file for packages that have documentation (a `README.md` file, deprecation notice, or stability indication).
eladb
suggested changes
Jun 3, 2019
packages/jsii-pacmak/test/expected.jsii-calc/dotnet/Amazon.JSII.Tests.CalculatorPackageId/.jsii
Show resolved
Hide resolved
- Moved `readme` back to it's own property - Stopped enforcing the stability banner in readme (belongs to another tool/layer) - Added `Stability.Deprecated`, and enforced that deprecated packages use it - Used the NodeJS stability index in documentation
RomainMuller
force-pushed
the
rmuller/api-stability
branch
from
4dad3d0
to
c935c0f
Compare
eladb
reviewed
Jun 4, 2019
There was a problem hiding this comment.
What about python/.NET? How will stability/deprecation look like for them?
Also, add a test that will demonstrate how deprecation is code-gened across the languages...
@rix0rrr can you remind me how this will propagate to individual API elements?
Sorry... This is jsii :-(
eladb
suggested changes
Jun 5, 2019
There was a problem hiding this comment.
Please make sure we have tests that cover all the cases (all stability levels) for all languages:
- Stability/deprecation at the package level
- Stability/deprecation at the class + method + property + enum + enum-member levels
We need to get this right the first time.
...cted.jsii-calc/java/src/main/java/software/amazon/jsii/tests/calculator/DeprecatedClass.java
Outdated
Show resolved
Hide resolved
packages/jsii-pacmak/test/expected.jsii-calc/python/src/jsii_calc/__init__.py
Show resolved
Hide resolved
eladb
approved these changes
Jun 5, 2019
packages/jsii-calc/lib/stability.ts
Outdated
| /** @deprecated for the show */ | ||
| export class DeprecatedClass { | ||
| /** @deprecated for the show */ | ||
| public readonly readonlyProperty: string = 'wazoo'; |
packages/jsii-dotnet-generator/src/Amazon.JSII.Generator/DocComment/DocCommentGeneratorBase.cs
Show resolved
Hide resolved
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.
Adds the necessary code to detect and forward module-level stability
indications to the assembly, so it can be used by downstream languages.
This effectively removes the
markdownattribute from theAssemblyinfavor of using the
docsattribute.Also, renders a
package-info.jsonfile for packages that havedocumentation (a
README.mdfile, deprecation notice, or stabilityindication).
Implements awslabs/cdk-ops#367