Skip to content

chore: add HTML tag to alpha package forward#18032

Merged
mergify[bot] merged 6 commits intomasterfrom
huijbers/forward-to-alpha
Dec 17, 2021
Merged

chore: add HTML tag to alpha package forward#18032
mergify[bot] merged 6 commits intomasterfrom
huijbers/forward-to-alpha

Conversation

@rix0rrr
Copy link
Copy Markdown
Contributor

@rix0rrr rix0rrr commented Dec 15, 2021

By tagging the <span> with a class, some JavaScript could detect the package reference at display time and turn it into a proper hyperlink.


By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

rix0rrr and others added 4 commits December 14, 2021 16:26
When ubergen generate a barebones README for an experimental package's
stable variant, add in a paragraph that directs users to the
experimental library so they have an easier time finding it.
@gitpod-io
Copy link
Copy Markdown

gitpod-io bot commented Dec 15, 2021

@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Dec 15, 2021
@mergify
Copy link
Copy Markdown
Contributor

mergify bot commented Dec 15, 2021

Title does not follow the guidelines of Conventional Commits. Please adjust title before merge.

@rix0rrr rix0rrr changed the title Huijbers/forward to alpha chore: add HTML tag to alpha package forward Dec 15, 2021
@rix0rrr rix0rrr requested a review from corymhall December 15, 2021 10:21
@rix0rrr rix0rrr self-assigned this Dec 15, 2021
'> as a separate package so that you can pin its version independently of the rest of the CDK. See the package:',
'>',
`> ${options.alphaPackageName}`,
`> <span class="package-reference">${options.alphaPackageName}</span>`,
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`> <span class="package-reference">${options.alphaPackageName}</span>`,
`> <span class="alpha-package-reference">${options.alphaPackageName}</span>`,

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't mind adding this, but I'm also not sure why it would matter whether the thing we're referring to is an alpha package or not.

Are you saying the following should not work:

<span class="alpha-package-reference">@aws-cdk/core</span>

(Leave alone whether we would emit that or not...)

Copy link
Copy Markdown
Contributor

@corymhall corymhall Dec 16, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh I see that is a good point. Nevermind.

@corymhall corymhall added the pr/do-not-merge This PR should not be merged at this time. label Dec 15, 2021
@rix0rrr rix0rrr removed the pr/do-not-merge This PR should not be merged at this time. label Dec 17, 2021
@mergify
Copy link
Copy Markdown
Contributor

mergify bot commented Dec 17, 2021

Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

@aws-cdk-automation
Copy link
Copy Markdown
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildProject89A8053A-LhjRyN9kxr8o
  • Commit ID: 99e188c
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@mergify mergify bot merged commit aca4d8b into master Dec 17, 2021
@mergify mergify bot deleted the huijbers/forward-to-alpha branch December 17, 2021 10:55
@mergify
Copy link
Copy Markdown
Contributor

mergify bot commented Dec 17, 2021

Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

TikiTDO pushed a commit to TikiTDO/aws-cdk that referenced this pull request Feb 21, 2022
By tagging the `<span>` with a class, some JavaScript could detect the package reference at display time and turn it into a proper hyperlink.

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

contribution/core This is a PR that came from AWS.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants