styleguidist/react-styleguidist

Testing examples in continuous integration

Open

#877 aperta il 19 mar 2018

Vedi su GitHub
 (3 commenti) (0 reazioni) (0 assegnatari)TypeScript (1416 fork)github user discovery
help wantedrequest for comments

Metriche repository

Star
 (11.091 star)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

My team's living styleguide is getting broken frequently without us noticing. In particular, examples in markdown files are falling out of date and end up broken. This is particularly concerning because those are supposed to be "best practice" snippets which are likely to be copy and pasted as a starting point for other devs.

This hasn't been an issue with storybook stories because the build will break in those cases, either because of snapshots changing or typescript will complain.

I would like to get our build failing in these cases so we catch this in CI. How would you recommend doing so? Is there documentation that I have overlooked?

I experimented with snapguistist, but there's no support for running those snapshots in CI yet and that wouldn't necessarily catch all classes of errors.

We're using react-docgen-typescript but I suppose this question is more general than that.

Guida contributor