Skip to content
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

Incomplete CHANGELOG #1275

Closed
szikszail opened this issue Jan 13, 2020 · 1 comment
Closed

Incomplete CHANGELOG #1275

szikszail opened this issue Jan 13, 2020 · 1 comment
Labels
📖 documentation Improvements or additions to documentation

Comments

@szikszail
Copy link

szikszail commented Jan 13, 2020

Could you please list the breaking changes in the formatter which are mentioned in CHANGELOG?

Custom formatters: Formatter helpers and EventDataCollector had breaking changes to support retry

Currently, it is really hard to figure out what changed and what must be changed to support Cucumber 6 if we create a custom formatter. E.g. getTestCaseData has been removed and it is not clear, how getTestCaseAttempt would replace it, or what other function does.

At the same time the link to EventDataCollector in the documentation is not valid.

@charlierudolph
Copy link
Member

charlierudolph commented Jan 15, 2020

Sorry, yes the custom formatters have never been documented all that well.

Note there are a lot of unreleased changes in master right now so I suggest looking at documentation via the tag of the release you are using: https://github.com/cucumber/cucumber-js/blob/v6.0.5/src/formatter/helpers/event_data_collector.js (then the link should work)

I think we can work on some better formatter documentation in Cucumber 7 (which will include the move to typescript and the use of a new internal structure for messages)

@aslakhellesoy aslakhellesoy added the 📖 documentation Improvements or additions to documentation label Feb 2, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📖 documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

4 participants