Skip to content

build(docs-infra): do not include CI-specific config in docs examples ZIP archives#36018

Closed
gkalpak wants to merge 2 commits intoangular:masterfrom
gkalpak:build-aio-exclude-protractor-ci-config
Closed

build(docs-infra): do not include CI-specific config in docs examples ZIP archives#36018
gkalpak wants to merge 2 commits intoangular:masterfrom
gkalpak:build-aio-exclude-protractor-ci-config

Conversation

@gkalpak
Copy link
Member

@gkalpak gkalpak commented Mar 11, 2020

In #35381, a new Protractor config file was introduced in docs examples, protractor-puppeteer.conf.js, that was only supposed to be used on CI and not be shipped with the ZIP archives provided for users to download and experiment with the docs examples locally.

The logic to ignore the protractor-puppeteer.conf.js file was incorrect, resulting in the file being retained in some examples (e.g. universal). The problem was not immediately obvious, because most examples explicitly specify all **/*.js files as ignored, but for other examples the file was retained in the ZIP archive.

This commit fixes the logic to ensure the file is excluded from all docs examples ZIP archives.

This PR also cleans up obsolete properties from zipper.json files.
See individual commit messages for more info.

Jira issue: FW-1992

@gkalpak gkalpak added area: build & ci Related the build and CI infrastructure of the project comp: docs-infra action: merge The PR is ready for merge by the caretaker target: patch This PR is targeted for the next patch release labels Mar 11, 2020
@ngbot ngbot bot modified the milestone: needsTriage Mar 11, 2020
@mary-poppins
Copy link

You can preview a4069c2 at https://pr36018-a4069c2.ngbuilds.io/.

gkalpak added 2 commits March 16, 2020 16:32
The `removeSystemJsConfig` and `type` properties (present in some
`zipper.json` files) are now obsolete and are not taken into account by
the example zipper:
- `removeSystemJsConfig` is no longer relevant since most examples have
  been migrated to use the CLI.
- `type` is no longer relevant, because the project type is determined
  based on the `projectType` property in `example-config.json` files.

This commit removes these properties from `zipper.json` files and
updates the `example-zipper` docs to not mention them.
… ZIP archives

In angular#35381, a new Protractor config file was introduced in docs examples,
`protractor-puppeteer.conf.js`, that was only supposed to be used on CI
and not be shipped with the ZIP archives provided for users to download
and experiment with the docs examples locally.

The logic to ignore the `protractor-puppeteer.conf.js` file was
incorrect, resulting in the file being retained in some examples (e.g.
[universal][1]). The problem was not immediately obvious, because most
examples explicitly specify all `**/*.js` files as ignored, but for
other examples the file was retained in the ZIP archive.

This commit fixes the logic to ensure the file is excluded from all docs
examples ZIP archives.

[1]: https://v9.angular.io/generated/zips/universal/universal.zip
@gkalpak gkalpak force-pushed the build-aio-exclude-protractor-ci-config branch from a4069c2 to fd45beb Compare March 16, 2020 14:36
@mary-poppins
Copy link

You can preview fd45beb at https://pr36018-fd45beb.ngbuilds.io/.

@gkalpak gkalpak added merge: caretaker note Alert the caretaker performing the merge to check the PR for an out of normal action needed or note and removed merge: caretaker note Alert the caretaker performing the merge to check the PR for an out of normal action needed or note labels Mar 18, 2020
@IgorMinar IgorMinar removed the request for review from alxhub March 24, 2020 17:52
@IgorMinar
Copy link
Contributor

lgtm - global approval

alxhub pushed a commit that referenced this pull request Mar 27, 2020
#36018)

The `removeSystemJsConfig` and `type` properties (present in some
`zipper.json` files) are now obsolete and are not taken into account by
the example zipper:
- `removeSystemJsConfig` is no longer relevant since most examples have
  been migrated to use the CLI.
- `type` is no longer relevant, because the project type is determined
  based on the `projectType` property in `example-config.json` files.

This commit removes these properties from `zipper.json` files and
updates the `example-zipper` docs to not mention them.

PR Close #36018
alxhub pushed a commit that referenced this pull request Mar 27, 2020
… ZIP archives (#36018)

In #35381, a new Protractor config file was introduced in docs examples,
`protractor-puppeteer.conf.js`, that was only supposed to be used on CI
and not be shipped with the ZIP archives provided for users to download
and experiment with the docs examples locally.

The logic to ignore the `protractor-puppeteer.conf.js` file was
incorrect, resulting in the file being retained in some examples (e.g.
[universal][1]). The problem was not immediately obvious, because most
examples explicitly specify all `**/*.js` files as ignored, but for
other examples the file was retained in the ZIP archive.

This commit fixes the logic to ensure the file is excluded from all docs
examples ZIP archives.

[1]: https://v9.angular.io/generated/zips/universal/universal.zip

PR Close #36018
@alxhub alxhub closed this in f9bc84c Mar 27, 2020
alxhub pushed a commit that referenced this pull request Mar 27, 2020
… ZIP archives (#36018)

In #35381, a new Protractor config file was introduced in docs examples,
`protractor-puppeteer.conf.js`, that was only supposed to be used on CI
and not be shipped with the ZIP archives provided for users to download
and experiment with the docs examples locally.

The logic to ignore the `protractor-puppeteer.conf.js` file was
incorrect, resulting in the file being retained in some examples (e.g.
[universal][1]). The problem was not immediately obvious, because most
examples explicitly specify all `**/*.js` files as ignored, but for
other examples the file was retained in the ZIP archive.

This commit fixes the logic to ensure the file is excluded from all docs
examples ZIP archives.

[1]: https://v9.angular.io/generated/zips/universal/universal.zip

PR Close #36018
@gkalpak gkalpak deleted the build-aio-exclude-protractor-ci-config branch March 28, 2020 11:11
@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 Apr 28, 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 target: patch This PR is targeted for the next patch release

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants