Skip to content

Add elements project type for boilerplate example projects#33484

Closed
yallen011 wants to merge 1 commit intoangular:masterfrom
yallen011:aio_elements_ex_prj_type
Closed

Add elements project type for boilerplate example projects#33484
yallen011 wants to merge 1 commit intoangular:masterfrom
yallen011:aio_elements_ex_prj_type

Conversation

@yallen011
Copy link
Copy Markdown
Contributor

@yallen011 yallen011 commented Oct 30, 2019

Added elements project type to the boilerplate sample projects to fix the issue with the angular elements example project in the Angular docs needing to be updated due to the angular elements package not being present in the package.json file when the zip file is downloaded.

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?

When downloading the zip from the https://angular.io/generated/zips/elements/elements.zip the @angular/elements package is not included in the package.json

Issue Number: #31332

What is the new behavior?

the @angular/elements package should now be included when downloading the following zip mentioned above.

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

@yallen011 yallen011 requested a review from a team October 30, 2019 03:13
@googlebot
Copy link
Copy Markdown

We found a Contributor License Agreement for you (the sender of this pull request), but were unable to find agreements for all the commit author(s) or Co-authors. If you authored these, maybe you used a different email address in the git commits than was used to sign the CLA (login here to double check)? If these were authored by someone else, then they will need to sign a CLA as well, and confirm that they're okay with these being contributed to Google.
In order to pass this check, please resolve this problem and then comment @googlebot I fixed it.. If the bot doesn't comment, it means it doesn't think anything has changed.

ℹ️ Googlers: Go here for more info.

@yallen011 yallen011 changed the title Add elements project type for boilerplate sample projects Add elements project type for boilerplate example projects Oct 30, 2019
@yallen011
Copy link
Copy Markdown
Contributor Author

@googlebot I fixed it.

@googlebot
Copy link
Copy Markdown

CLAs look good, thanks!

ℹ️ Googlers: Go here for more info.

@kapunahelewong kapunahelewong added comp: docs effort2: days target: patch This PR is targeted for the next patch release risk: low feature Label used to distinguish feature request from other issues labels Oct 30, 2019
@ngbot ngbot Bot modified the milestone: Backlog Oct 30, 2019
@yallen011 yallen011 force-pushed the aio_elements_ex_prj_type branch from 47d859d to 8c0699d Compare October 31, 2019 02:10
@yallen011 yallen011 requested a review from a team October 31, 2019 02:33
@yallen011 yallen011 force-pushed the aio_elements_ex_prj_type branch from 61c9fe8 to 66e1a17 Compare October 31, 2019 03:30
Copy link
Copy Markdown
Contributor

@petebacondarwin petebacondarwin left a comment

Choose a reason for hiding this comment

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

Great first PR @yallen011 !!

One small change please. In the commit message you don't need to add the PR Close #31332 line.
Our merge script will add this line with a link back to this PR. Please can change that line in your commit message to

Fixes #31332

@petebacondarwin petebacondarwin added the action: cleanup The PR is in need of cleanup, either due to needing a rebase or in response to comments from reviews label Nov 11, 2019
Copy link
Copy Markdown
Member

@gkalpak gkalpak left a comment

Choose a reason for hiding this comment

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

Thx, @yallen011
I left a couple more comments, but otherwise this lgtm 👍

Comment thread aio/tools/examples/example-boilerplate.js Outdated
Comment thread aio/tools/examples/shared/boilerplate/elements/angular.json Outdated
Comment thread aio/tools/examples/shared/boilerplate/elements/package.json Outdated
@yallen011
Copy link
Copy Markdown
Contributor Author

Ok, I will make the changes and resubmit.

Copy link
Copy Markdown
Member

@gkalpak gkalpak left a comment

Choose a reason for hiding this comment

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

One minor comment, but otherwise lgtm 🎉
Also, please, update the commit message (which is already in a pretty good form) to more closely follow our guidelines:

fix(docs-infra): add boilerplate path and project type for elements example project

Fixes #31332

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.

Incorrect aplhabetic order: core should be above elements 😃

@gkalpak
Copy link
Copy Markdown
Member

gkalpak commented Nov 18, 2019

Oh, also, please rebase on master to make CI green.

@yallen011
Copy link
Copy Markdown
Contributor Author

Hi @gkalpak I read the doc for the commit message again, but I'm not sure what needs to be modified.

@gkalpak
Copy link
Copy Markdown
Member

gkalpak commented Nov 19, 2019

I've included a suggested commit message in my previous comment 😃 #33484 (review)

@gkalpak
Copy link
Copy Markdown
Member

gkalpak commented Nov 19, 2019

BTW, it seems you also need to rebase on master to make CI green. (You can follow the instructions in #33829 (comment).)

@yallen011
Copy link
Copy Markdown
Contributor Author

Ok, I see. I misread the comment asking me to change Closes to Fixes I read it as remove that part all together. I will update code and comment then rebase.

@gkalpak
Copy link
Copy Markdown
Member

gkalpak commented Nov 19, 2019

Both Closes and Fixes (and a few others) work. The important part is to include it on a new line on its own, at the bottom of the commit message, separated by an empty line from the rest of the message.

The current commit message is:

fix(docs-infra): add boilerplate path and project type for elements example project (#31332)

My suggestion is to change it to:

fix(docs-infra): add boilerplate path and project type for elements example project

Fixes #31332

(LMK if you run into difficulties updating the commit message or rebasing. Thx again for working on this 👍)

@yallen011
Copy link
Copy Markdown
Contributor Author

@gkalpak that's the way I had it at first. On a new line at the bottom of the commit message.

@gkalpak
Copy link
Copy Markdown
Member

gkalpak commented Nov 19, 2019

@yallen011, according to GitHub this is the initial PR commit 🤷‍♂
Maybe something got messed up during rebasing/amending?

@yallen011 yallen011 force-pushed the aio_elements_ex_prj_type branch from c082cf0 to 1728e63 Compare November 22, 2019 04:17
@yallen011
Copy link
Copy Markdown
Contributor Author

ok, updated changes and forced pushed to kick off CI job

@mary-poppins
Copy link
Copy Markdown

@ajitsinghkaler
Copy link
Copy Markdown
Contributor

@gkalpak I think this commit is ready to merge can you please have a look

@gkalpak gkalpak added action: merge The PR is ready for merge by the caretaker and removed action: cleanup The PR is in need of cleanup, either due to needing a rebase or in response to comments from reviews labels Mar 6, 2020
@ngbot
Copy link
Copy Markdown

ngbot Bot commented Mar 6, 2020

I see that you just added the PR action: merge label, but the following checks are still failing:
    failure status "pullapprove" is failing
    pending 1 pending code review

If you want your PR to be merged, it has to pass all the CI checks.

If you can't get the PR to a green state due to flakes or broken master, please try rebasing to master and/or restarting the CI job. If that fails and you believe that the issue is not due to your change, please contact the caretaker and ask for help.

Copy link
Copy Markdown
Member

@gkalpak gkalpak left a comment

Choose a reason for hiding this comment

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

Thx for making the changes, @yallen011! LGTM ✨
I've totally missed that I needed to re-review this. Thx for the ping, @ajitsinghkaler 👍

@matsko
Copy link
Copy Markdown
Contributor

matsko commented Mar 6, 2020

@yallen011 please rebase.

@gkalpak gkalpak force-pushed the aio_elements_ex_prj_type branch from 1728e63 to 4b8f7fe Compare March 10, 2020 11:40
@gkalpak
Copy link
Copy Markdown
Member

gkalpak commented Mar 10, 2020

Rebased on master.

@mary-poppins
Copy link
Copy Markdown

@AndrewKushnir
Copy link
Copy Markdown
Contributor

@gkalpak do we need to update Angular package versions from ^8.0.0 to ^9.0.0?

@gkalpak
Copy link
Copy Markdown
Member

gkalpak commented Mar 11, 2020

@AndrewKushnir, this should be merged as is (to be consistent with the rest of the examples). I am updating the examples to v9/Ivy in #34374.

@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 Apr 11, 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 cla: yes effort2: days feature Label used to distinguish feature request from other issues risk: low target: patch This PR is targeted for the next patch release

Projects

None yet

Development

Successfully merging this pull request may close these issues.

9 participants