We are developing alongside a sister service project which our project depends on. We do periodic tests against our version X against their version Y and we need a way to document that X works with Y when the tests are complete.

Note that this falls outside of e.g. NPM or package.json since the services we develop against are not formally versioned in a package management system.

Ideally it would ...

  • Be updatable by testers
  • Be linked closely with releases - ideally this would be in source control alongside the code but we have a chicken egg situation where we create a release, then testing happens, then the source would need updating with the test results which is a bit janky
  • Document current as well as past version pairings

I'm thinking of something along the lines of CHANGELOG.md but hosted externally maybe?

The de-facto standards for changelogs such as https://keepachangelog.com/en/1.0.0/ don't mention documenting service dependencies

Google searches for 'documenting service dependencies' or similar comes back with mostly results on how to document APIs such as Swagger.

Your Answer

By clicking "Post Your Answer", you acknowledge that you have read our updated terms of service, privacy policy and cookie policy, and that your continued use of the website is subject to these policies.

Browse other questions tagged or ask your own question.