Skip to content

build: fix docs-content release output #17125

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

Merged
merged 8 commits into from
Sep 18, 2019

Conversation

devversion
Copy link
Member

@devversion devversion commented Sep 18, 2019

Subset of #17046. Also includes #17126.

@googlebot googlebot added the cla: yes PR author has agreed to Google's Contributor License Agreement label Sep 18, 2019
Fixes the missing metadata for example modules. This happens because
we built the individual example modules without a flat module bundle. Not
building with a flat module bundle means that metadata will not be generated
in the `ng_module` bazel rule.
Applies a workaround for the invalid imports generation issue
in the Bazel `ng_module` rule. Read more about this here:

https://hackmd.io/@devversion/ryCOwIKIS.
This is necessary as `ng_module` rules with a `module_name` either
need a `public-api.ts` or `module.ts` file.
@devversion devversion force-pushed the build/docs-content-metadata branch from 5bb4a2f to 2727e4b Compare September 18, 2019 12:16
Apparently the `google-maps` package has the same problem
as the `material-examples` package where the metadata for
the Bazel sub-packages is not incldued in the entry-point of
the `@angular/google-maps` entry-point. There are two solutions
to make it work with Angular package format:

* Making the packages generate flat module bundles and including
them as secondary entry-points
* Only having one Bazel package so that metadata will be included
in the flat module bundle.

I chose the latter as the `google-maps` package is still very small
and doesn't have a lot of dependencies, so in terms of speed it is
even faster to have on package. Also it seems like there were never
plans to have secondary entry-points for that package.

*Note*: we need this commit as part of the docs-content fix because
the google-maps package runs on CI and will fail as it misses various
`public-api.ts` files for the flat module bundles.
Looks like a few examples were missing the `MatButtonModule` after
the restructuring of the examples. I've noticed these while manually
testing the Bazel release output in the docs app.
We no longer can build the examples package through gulp. This is
because we did not add individual `tsconfig-build.json` files to
the nested entry-points when we did the restructuring of the examples.

This now breaks as the primary entry-point uses module name
imports as of the docs-content metadata fix. It's okay to not build the
examples package through gulp in the `8.2.x` branch as we don't
need it in the gulp setup anyway.
@devversion
Copy link
Member Author

devversion commented Sep 18, 2019

Note: this should only o into the 8.2.x branch so that the docs-content will be published properly. It's a subset of #17046 with a few modifications to make it work in the 8.2.x branch.

@devversion devversion 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 Sep 18, 2019
@devversion
Copy link
Member Author

Also note that there are a few CI checks which are actually removed, but still show up because they are marked as required in the Github UI. Maybe we can remove these for project health?

@devversion devversion marked this pull request as ready for review September 18, 2019 12:48
@devversion devversion requested review from jelbourn, mmalerba and a team as code owners September 18, 2019 12:48
@mmalerba mmalerba added the target: patch This PR is targeted for the next patch release label Sep 18, 2019
Copy link
Member

@jelbourn jelbourn left a comment

Choose a reason for hiding this comment

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

LGTM

@jelbourn jelbourn added pr: lgtm action: merge The PR is ready for merge by the caretaker labels Sep 18, 2019
@jelbourn jelbourn merged commit e05a966 into angular:8.2.x Sep 18, 2019
@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 Oct 19, 2019
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 PR author has agreed to Google's Contributor License Agreement 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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants