Implement module for diffing two repositories.yml files

sgnn7 commented 4 years ago

AC:

[ ] Using a baseline repositories yml file (CURRENT_VER), you can use a second repositories yml file (NEW_VER) to determine what versions should be included in the release and changelog. The output of those release notes and changelog would include all versions of a component betwen version in NEW_VER yaml up-to-but-excluding version in CURRENT_VER yaml.

Eg:

repositories_current.yml

...
    repos:
...
      - name: cyberark/conjur-oss-helm-chart
        url: https://github.com/cyberark/conjur-oss-helm-chart
        description: Helm chart for deploying Conjur OSS.
        version: v1.3.7
...

repositories_new.yml

...
    repos:
...
      - name: cyberark/conjur-oss-helm-chart
        url: https://github.com/cyberark/conjur-oss-helm-chart
        description: Helm chart for deploying Conjur OSS.
        version: v2.1.1
...

The resulting changelog and release notes would include all released changes in the cyberark/conjur-oss-helm-chart repo from version v2.1.1 down to (but excluding) v1.3.7.

BradleyBoutcher commented 4 years ago

I have a few questions to clarify

For the CLI flag, should it optionally take an array of filenames, or should we have a separate flag for a second filename?
Should we always use NewConfig with two parameters (i.e. change the signature, but pass in an empty string when there is no second filename given)
If the version in current is older than the version in new (i.e. a mistake), should we ignore the version in new?

sgnn7 commented 4 years ago

For the CLI flag, should it optionally take an array of filenames, or should we have a separate flag for a second filename?

Per the card, this card is only for creating a module that can do this diff and not for also tying it into the CLI. That part will be a separate card so you won't have to worry about that yet.

Should we always use NewConfig with two parameters (i.e. change the signature, but pass in an empty string when there is no second filename given)

This is up to your discretion but I think that kind of coercion is not needed. After we fully have diffing and we have a n-1 release it might be something that we move towards though.

If the version in current is older than the version in new (i.e. a mistake), should we ignore the version in new?

Anything that we don't expect to happen should be a fatal/visible error. Since most of this will be automated, errors that are eaten will result in problems that we won't notice quickly enough.

cyberark / conjur-oss-suite-release

Implement module for diffing two repositories.yml files #75