Explain how this repository is affected by the automation stored at
canonical/snap-tempest-automation and how to alter the algorithm
behavior with overrides.
* Rework links and add a section on how to review automated PRs
Fixes #111
* Apply suggestions
---------
Co-authored-by: Gabriel Cocenza <email address hidden>
Rework and preserve comments in snapcraft.yaml during dependency updates (#122)
The comments regarding confluent-kafka will be overwritting by
tools/update_snapcraft.py when refreshing dependency versions
because pyYAML doesn't support comments. Use ruamel.yaml instead
with its round trip mode to solve the problem.
Also replacing the previous comment (since it's also in
requirements-manual.txt) with a new one that informs user that
some dependencies are automatically generated. This also gives user
a hint about where to check when they are unsure why a package like
confluent-kafka is added as a dependency.
These comments are important for context,
and will help in future when version updates are required,
and for rationale of rejecting auto dependabot updates, etc.
