Repository navigation
docs(examples): build the API-Only TranscriberJ examples with TranscriberJ 0.3.6 and Publisher 0.7.0 - #94
Merged
Conversation
…iberJ 0.3.6 and Publisher 0.7.0
Owner
Author
|
🎉 This PR is included in version 1.0.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
Owner
Author
|
🎉 This PR is included in version 1.0.2 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
Owner
Author
|
🎉 This PR is included in version 0.2.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
Owner
Author
|
🎉 This PR is included in version 1.0.2 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
Owner
Author
|
🎉 This PR is included in version 1.0.1 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Both API-Only TranscriberJ examples now build with the current releases:
com.arc-e-tect.api-only-transcriberj0.3.2 goes to 0.3.6, ingradle/libs.versions.toml;@arc-e-tect/api-only-publisher0.5.0 goes to 0.7.0, inpackage.jsonandpackage-lock.json.The REST Docs emitter stays at 0.1.1, which is still its latest release.
Why
The guides in the API repository run these examples and record the versions they were verified with. Arc-E-Tect/SoftwareEngineeringDoneRight-API#35 re-ran them with these releases and now records them, so the examples have to build with the same versions.
Verified
In each example, I ran every command and experiment in its guide with these versions:
./gradlew test, with-PdocsLocale=nland with-PdocsLocale=fr. The generatedKEYS, the generation report and the generated field line match the guide. So do the Dutch fallback experiment, the new-field experiment (the report and the placeholder line) and the renamed-schema orphan test's message../gradlew checkruns 23 tests, all passing. The report,CreateRefundOperation's constants and the degradedbody(...)match the guide. The removed-constant experiment gives two compile errors, which this README already says; the guide now shows both. The renamed-member guard's hashes match, and so does the named-branches remedy (the Javadoc andCardRefundV1.body).Neither
apionly.lockchanged: Publisher 0.7.0 builds both contracts byte for byte as 0.5.0 did.Note
TranscriberJ 0.3.6 still brings in Subscriber 0.2.1, so these examples use that Subscriber. That is being fixed in the TranscriberJ itself, in the API repository; neither example sets anything that 0.2.1 lacks.