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

Please add code examples for consumer version selectors docs in pact.docs.io #1149

Closed
bethesque opened this issue Jun 26, 2020 · 6 comments
Closed

Comments

@bethesque
Copy link
Member

As part of the process of making the Pact docs more user friendly, we'd like to start writing feature documentation once, and providing code examples for each of the languages, rather than everyone having to write the same docs over and over again in each language.

The documentation for the consumer version selectors can be our first opportunity to give this approach a try. I have written the behavioural docs, but we need code examples from each of the languages. Can one of the maintainers of this repository (or any other Pact user of this language!) please add (via direct edit/PR as your permissions allow) code samples for the examples found here https://docs.pact.io/pact_broker/advanced_topics/consumer_version_selectors#examples If you press the EDIT button, it will automatically fork and open a page to edit.

To add a new language, just add a comment with the name of the language (eg. ) and an example surrounded by "```".

If you would like to link to these docs in your own READMEs, please use the short link https://docs.pact.io/consumer_version_selectors (rather than the deep link into the broker section).

Thanks all!

@tinexw
Copy link
Contributor

tinexw commented Oct 10, 2020

Hi,

the documentation seems to already contain Java examples (well, JUnit to be fair). The referenced class in them does not exist so I opened a small PR to fix that: pact-foundation/docs.pact.io#37

Some features are currently not supported by JUnit so I was wondering to mention that in the docs? Otherwise I would suggest to close this ticket. Let me know what you think.

@uglyog
Copy link
Member

uglyog commented Oct 17, 2020

@tinexw do you know which features are not supported? We should implement them, if that is the case.

@tinexw
Copy link
Contributor

tinexw commented Oct 17, 2020

In the docs three more examples are mentioned for Ruby and Java:

  1. Using a fallback tag for coordinated branch development
  2. Verifying a pacts where one consumer is a mobile application
  3. Verifying the overall latest pact for each consumer

They map from what I can tell to the following features:

  1. Support for fallbackTag
  2. Support for consumer
  3. Support only latest (without having to specify a tag)

If you can confirm that those are not supported I can create dedicated issues for each of them (and might start working on it ;-) )

@tinexw
Copy link
Contributor

tinexw commented Oct 17, 2020

Actually, it’s not true what I wrote above (At least not in the current version, it was true for 4.1.7). Only 1. is missing (fallback tag)
I will update the docs accordingly and create a new issue for the fallback tag in this repo.

@tinexw
Copy link
Contributor

tinexw commented Oct 18, 2020

Actually, there already seems to be a ticket for the fallback tag: #946
Maybe you can change the description? Then we don't need to create a new one.

@uglyog
Copy link
Member

uglyog commented Oct 23, 2020

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants