Skip to content

fix(docs-infra): convert hard-coded cli-builder examples into proper mini-app - #34362

Closed
sonukapoor wants to merge 1 commit into
angular:masterfrom
sonukapoor:extract-hardcoded-from-cli-builder-into-files
Closed

sonukapoor wants to merge 1 commit into
angular:masterfrom
sonukapoor:extract-hardcoded-from-cli-builder-into-files

Conversation

@sonukapoor

@sonukapoor sonukapoor commented Dec 12, 2019 •

Copy link
Copy Markdown
Contributor

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • angular.io application / infrastructure changes
  • Other... Please describe:

What is the current behavior?

Issue Number: #34314

What is the new behavior?

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Closes: #34314

@sonukapoor
sonukapoor requested a review from a team December 12, 2019 02:37
@gkalpak gkalpak added aio: preview area: build & ci Related the build and CI infrastructure of the project action: review The PR is still awaiting reviews from at least one requested reviewer target: patch This PR is targeted for the next patch release labels Dec 12, 2019
@mary-poppins

Copy link
Copy Markdown

You can preview 5ff281b at https://pr34362-5ff281b.ngbuilds.io/.

@ngbot ngbot Bot added this to the needsTriage milestone Dec 12, 2019

@gkalpak gkalpak left a comment •

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Nice! I left a few comments, but this is definitely on the right track 👍
Thx, @sonukapoor ✨

BTW, why the empty main.ts file?

Comment thread .github/CODEOWNERS Resolved
Comment thread .github/CODEOWNERS Resolved
Comment thread .github/CODEOWNERS Resolved
Comment thread aio/content/guide/cli-builder.md Resolved
Comment thread aio/content/guide/cli-builder.md Resolved
@sonukapoor
sonukapoor requested a review from gkalpak December 12, 2019 19:51
@mary-poppins

Copy link
Copy Markdown

You can preview c776fb0 at https://pr34362-c776fb0.ngbuilds.io/.

@gkalpak gkalpak left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Some more (mostly minor) comments to go 👏
@sonukapoor, could you also create a new GitHub issue to track adding tests for the cli-builder example?

Comment thread aio/content/guide/cli-builder.md Resolved
Comment thread aio/content/guide/cli-builder.md Resolved
Comment thread aio/content/guide/cli-builder.md Resolved
Comment thread aio/content/guide/cli-builder.md Resolved
Comment thread aio/content/guide/cli-builder.md Resolved
@sonukapoor

Copy link
Copy Markdown
Contributor Author

Some more (mostly minor) comments to go 👏
@sonukapoor, could you also create a new GitHub issue to track adding tests for the cli-builder example?

#34393

@sonukapoor
sonukapoor requested a review from gkalpak December 13, 2019 14:15
@mary-poppins

Copy link
Copy Markdown

You can preview f752948 at https://pr34362-f752948.ngbuilds.io/.

@mary-poppins

Copy link
Copy Markdown

You can preview 07ab466 at https://pr34362-07ab466.ngbuilds.io/.

@gkalpak gkalpak left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

One last comment to go 🎉

Can you also squash all commits together into one and change the commit message to something like:

fix(docs-infra): convert hard-coded `cli-builder` examples into a proper mini-app

Previously, the examples in the `cli-builder` guide were hard-coded.
This made it impossible to test them and verify they are correct.

This commit fixes this by converting them into a proper mini-app. In a
subsequent commit, tests will be added to verify that the source code
works as expected (and guard against regressions).

Fixes #34314

BTW, Closes #34314 would work too, but not Closes: #34314 (there should be no semi-colon).

Comment thread aio/content/guide/cli-builder.md Resolved
…per mini-app

Previously, the examples in the `cli-builder` guide were hard-coded.
This made it impossible to test them and verify they are correct.

This commit fixes this by converting them into a proper mini-app. In a
subsequent commit, tests will be added to verify that the source code
works as expected (and guard against regressions).

Fixes angular#34314
@sonukapoor
sonukapoor force-pushed the extract-hardcoded-from-cli-builder-into-files branch from 07ab466 to dd9793f Compare December 14, 2019 22:16
@sonukapoor
sonukapoor requested a review from gkalpak December 14, 2019 22:17
@mary-poppins

Copy link
Copy Markdown

You can preview dd9793f at https://pr34362-dd9793f.ngbuilds.io/.

@gkalpak gkalpak left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Great job, @sonukapoor 👏
(Thx for seeing this through ⭐️)

@Splaktar

Copy link
Copy Markdown
Contributor

@mgechev this is one that you probably want to take a look at.

@gkalpak gkalpak added action: merge The PR is ready for merge by the caretaker and removed action: review The PR is still awaiting reviews from at least one requested reviewer labels Dec 16, 2019
@kara kara added the action: review The PR is still awaiting reviews from at least one requested reviewer label Dec 16, 2019
@gkalpak gkalpak changed the title fix(docs-infra): convert hard-coded cli-builder examples into proper … fix(docs-infra): convert hard-coded cli-builder examples into proper mini-app Dec 30, 2019
@sonukapoor

Copy link
Copy Markdown
Contributor Author

@IgorMinar Could you please review this one? Thanks

@atscott atscott removed the action: merge The PR is ready for merge by the caretaker label Jan 9, 2020

@Splaktar Splaktar left a comment

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.

LGTM. This fixes a number of issues that can cause confusion when going through this guide. It would be helpful to get this into version 9.

@IgorMinar IgorMinar left a comment

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.

Thank you!

@IgorMinar IgorMinar added action: merge The PR is ready for merge by the caretaker and removed action: review The PR is still awaiting reviews from at least one requested reviewer labels Jan 19, 2020
@gkalpak gkalpak added the merge: caretaker note Alert the caretaker performing the merge to check the PR for an out of normal action needed or note label Jan 19, 2020
@gkalpak

gkalpak commented Jan 19, 2020

Copy link
Copy Markdown
Member

@caretaker: Global approvals for the docs-only changes.

matsko pushed a commit that referenced this pull request Jan 21, 2020
…per mini-app (#34362)

Previously, the examples in the `cli-builder` guide were hard-coded.
This made it impossible to test them and verify they are correct.

This commit fixes this by converting them into a proper mini-app. In a
subsequent commit, tests will be added to verify that the source code
works as expected (and guard against regressions).

Fixes #34314

PR Close #34362
@matsko matsko closed this in 15ae924 Jan 21, 2020
@angular-automatic-lock-bot

Copy link
Copy Markdown

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

@angular-automatic-lock-bot angular-automatic-lock-bot Bot locked and limited conversation to collaborators Feb 21, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

action: merge The PR is ready for merge by the caretaker area: build & ci Related the build and CI infrastructure of the project cla: yes merge: caretaker note Alert the caretaker performing the merge to check the PR for an out of normal action needed or note target: patch This PR is targeted for the next patch release type: bug/fix

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: cli-builder examples are hard-coded

10 participants