Testing examples in continuous integration
#877 aberto em 19 de mar. de 2018
Métricas do repositório
- Stars
- (11.091 stars)
- Métricas de merge de PR
- (Métricas PR pendentes)
Description
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.