Skip to content

build: avoid file collisions in docs-content #18691

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

Conversation

devversion
Copy link
Member

Currently we always move guides, overviews, example files into
the docs-content by their basename. This means that no guides,
overviews, example files with the same name can exist. The last
one being processed by Bazel overwrites the previous ones.

This can be currently observed in the docs where the custom
form-field control example incorrectly displays the MDC-based
form-field custom control example. Ultimately breaking the StackBlitz.

For example: https://material.angular.io/guide/creating-a-custom-form-field-control.
Click on the first example, and open it on StackBlitz.

We can fix this by preserving the directories where the guides,
overviews and example files have been copied from. This also allows
us to have multiple overviews in a package without the risk of collisions.

Note: Needs an corresponding change in the material.angular.io repo.

@devversion devversion added P3 An issue that is relevant to core functions, but does not impede progress. Important, but not urgent target: patch This PR is targeted for the next patch release labels Mar 3, 2020
@devversion devversion requested a review from a team as a code owner March 3, 2020 13:59
@googlebot googlebot added the cla: yes PR author has agreed to Google's Contributor License Agreement label Mar 3, 2020
Copy link
Member

@josephperrott josephperrott 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
Copy link
Member

jelbourn commented Mar 3, 2020

Looks like a formatting lint warning

Currently we always move guides, overviews, example files into
the `docs-content` by their basename. This means that no guides,
overviews, example files with the same name can exist. The last
one being processed by Bazel overwrites the previous ones.

This can be currently observed in the docs where the custom
form-field control example incorrectly displays the MDC-based
form-field custom control example. Ultimately breaking StackBlitz.

For example: https://material.angular.io/guide/creating-a-custom-form-field-control.
Click on the first example, and open it on StackBlitz.

We can fix this by preserving the directories where the guides,
overviews and example files have been copied from. This also allows
us to have multiple overviews in a package without the risk of
collisions.

Note: Needs an corresponding change in the material.angular.io repo.
@devversion devversion force-pushed the build/avoid-colliding-docs-content branch from b5a72a1 to 8dffd61 Compare March 3, 2020 20:20
@devversion
Copy link
Member Author

@jelbourn Fixed.

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 the action: merge The PR is ready for merge by the caretaker label Mar 3, 2020
@ngbot
Copy link

ngbot bot commented Mar 3, 2020

I see that you just added the pr: merge ready label, but the following checks are still failing:
    failure status "ci/circleci: api_golden_checks" is failing

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.

@mmalerba mmalerba merged commit ce22f1b into angular:master Mar 4, 2020
mmalerba added a commit that referenced this pull request Mar 6, 2020
Currently we always move guides, overviews, example files into
the `docs-content` by their basename. This means that no guides,
overviews, example files with the same name can exist. The last
one being processed by Bazel overwrites the previous ones.

This can be currently observed in the docs where the custom
form-field control example incorrectly displays the MDC-based
form-field custom control example. Ultimately breaking StackBlitz.

For example: https://material.angular.io/guide/creating-a-custom-form-field-control.
Click on the first example, and open it on StackBlitz.

We can fix this by preserving the directories where the guides,
overviews and example files have been copied from. This also allows
us to have multiple overviews in a package without the risk of
collisions.

Note: Needs an corresponding change in the material.angular.io repo.
@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 4, 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 PR author has agreed to Google's Contributor License Agreement P3 An issue that is relevant to core functions, but does not impede progress. Important, but not urgent 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