Skip to content
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: Explain how ngsw.json is generated. #44823

Closed
wants to merge 1 commit into from

Conversation

Arjen-1
Copy link
Contributor

@Arjen-1 Arjen-1 commented Jan 25, 2022

ngsw.json is the manifest file which is generated at build time ( based on ngsw-config.json ). This explains this a bit clearer.
At first, I thought that it was a wrongly named filename. Not is it explicitly described.

PR Type

Docs

  • 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?

Its not explained how ngsw is created and how it differs from ngsw-config

What is the new behavior?

It explains it.

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Still a proces of my first contribution!

@pullapprove pullapprove bot requested a review from alxhub January 25, 2022 18:35
@Arjen-1
Copy link
Contributor Author

Arjen-1 commented Jan 26, 2022

I'd love to know if my first contribution has a green light ! :D

@gkalpak gkalpak added action: review The PR is still awaiting reviews from at least one requested reviewer comp: docs area: service-worker Issues related to the @angular/service-worker package target: patch This PR is targeted for the next patch release labels Jan 26, 2022
@ngbot ngbot bot modified the milestone: Backlog Jan 26, 2022
Copy link
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, @Arjen-1 ❤️
I made a small suggestion - otherwise lgtm 👍

aio/content/guide/service-worker-devops.md Outdated Show resolved Hide resolved
@gkalpak gkalpak added action: cleanup The PR is in need of cleanup, either due to needing a rebase or in response to comments from reviews and removed action: review The PR is still awaiting reviews from at least one requested reviewer labels Jan 26, 2022
@Arjen-1
Copy link
Contributor Author

Arjen-1 commented Jan 26, 2022

Thanks @gkalpak , the suggestion looks good!

@gkalpak gkalpak added aio: preview 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 Jan 26, 2022
@mary-poppins
Copy link

You can preview ae49391 at https://pr44823-ae49391.ngbuilds.io/.
You can preview 21c1180 at https://pr44823-21c1180.ngbuilds.io/.

Copy link
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 update, @Arjen-1 👍
LGTM :shipit:

@gkalpak
Copy link
Member

gkalpak commented Jan 26, 2022

Oh, wait! Can you please squash the commits into one?

@gkalpak gkalpak 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 Jan 26, 2022
@gkalpak gkalpak removed the request for review from alxhub January 26, 2022 18:16
@Arjen-1
Copy link
Contributor Author

Arjen-1 commented Jan 27, 2022

@gkalpak , I believe it's squashed into one commit now. Thanks for the tip!

@gkalpak
Copy link
Member

gkalpak commented Jan 28, 2022

The for squashing, @Arjen-1. I'm afraid there are some more changes needed, though 😅
The commit message has to follow our commit message guidelines. So, could you change it again to something like your original commit message? 🙏
For example:

docs: explain how `ngsw.json` is generated

`ngsw.json` is the manifest file which is generated at build time (based
on `ngsw-config.json`). This commit explains this a bit clearer. At
first, I thought that it was a wrongly named filename. Now is it
explicitly described.

@gkalpak
Copy link
Member

gkalpak commented Jan 28, 2022

I forgot to mention that we also need you to sign the CLA before we can merge this PR, @Arjen-1. See here for more details.

@Arjen-1
Copy link
Contributor Author

Arjen-1 commented Jan 31, 2022

@gkalpak , I've done the CLA step and restored the correct commit message. Any more steps that need to be done?
If so, no problem!
Of not, yay! I almost made my first contribution!

Update aio/content/guide/service-worker-devops.md

ngsw.json is the manifest file which is generated at build time ( based on ngsw-config.json ). This explains this a bit clearer.
At first, I thought that it was a wrongly named filename. Not is it explicitly described.

Co-Authored-By: George Kalpakas <kalpakas.g@gmail.com>
@AndrewKushnir
Copy link
Contributor

@Arjen-1 thanks for addressing the feedback. I've noticed that the setup CI job is failing and I've rebased the PR on top of the most recent version of the master branch. I'm adding this PR to the merge queue. Thanks for improving Angular docs!

@AndrewKushnir AndrewKushnir 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 Feb 1, 2022
@mary-poppins
Copy link

You can preview d0c5449 at https://pr44823-d0c5449.ngbuilds.io/.

@jessicajaniuk
Copy link
Contributor

This PR was merged into the repository by commit 9f5edce.

jessicajaniuk pushed a commit that referenced this pull request Feb 1, 2022
Update aio/content/guide/service-worker-devops.md

ngsw.json is the manifest file which is generated at build time ( based on ngsw-config.json ). This explains this a bit clearer.
At first, I thought that it was a wrongly named filename. Not is it explicitly described.

Co-Authored-By: George Kalpakas <kalpakas.g@gmail.com>

PR Close #44823
@angular-automatic-lock-bot
Copy link

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 Mar 4, 2022
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 aio: preview area: service-worker Issues related to the @angular/service-worker package target: patch This PR is targeted for the next patch release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants