Skip to content
This repository was archived by the owner on Mar 4, 2020. It is now read-only.

Docs example can be broken and merge into master without any check #554

Closed
mnajdova opened this issue Dec 4, 2018 · 2 comments · Fixed by #644
Closed

Docs example can be broken and merge into master without any check #554

mnajdova opened this issue Dec 4, 2018 · 2 comments · Fixed by #644
Labels
vsts Paired with ticket in vsts

Comments

@mnajdova
Copy link
Contributor

mnajdova commented Dec 4, 2018

Bug Report

Steps

With the latest release and the changes introduced for the Editor, we introduced problems with one of the examples for the Popup which was using react-dom. Currently this is how the example looks.
image

Expected Result

The examples on the docs should always work. We must provide some way of testing this, not just the screens of the examples, as those are tested in an isolated (popout) mode.

Actual Result

We may introduce problems in the docs example, and those are not caught.

Version

0.13.1

@layershifter
Copy link
Member

We can try to render them with SourceRender and throw error if it happened.

@pkumarie2011 pkumarie2011 added the vsts Paired with ticket in vsts label Dec 5, 2018
@levithomason
Copy link
Member

levithomason commented Dec 7, 2018

We had a test in Semantic UI React that simply renders all examples and ensures there were no errors. We should do the same.

Just note that the example file needs to be rendered through the ComponentExample opposed to render the example file source directly. This way, we are sure the example works in the editor and not just that the example itself works.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
vsts Paired with ticket in vsts
Projects
None yet
4 participants