telus-agcg / danger Goto Github PK

Add Danger checks to check if YAMLs were updated in case any jsonnet template was updated (and vice-versa)

Ensure that when a change is being made to a reall program-set (not n/a) that an update has been made to the CHANGELOG as well. There is some "prior art" on this: https://github.com/technekes/danger/blob/094701d5ebab826b5952d8c80bdfeba6b2664691/gems/Dangerfile#L29-L34

PR's from Dependabot do not include a CHANGELOG entry and should not fail.

There is an edge case where all of the tokens (PR title, commit title, branch) pointed at a particular program-set but the actual changes were in a different directory.

This check accounts for the the newer syntax:

it 'does stuff', :focus do
  ...
end

but not the older format of:

it 'does stuff', focus: true do
  ...
end

# or

it 'does stuff', 'focus' => true do
  ...
end

Add a check to make sure the branch name is hyphenated instead of underscored.

With the addition of SQLite visualization feature, we need to add a check for debug: true present in configuration examples.

This follows our documented process and saves from manually having to make comments like this.

PR's should always (I think) include a link to a sized and prioritized Issue.

Exceptions:

• Version bumps
• Dependabot PR

Add a check for changed rendered programs ([program-set]/programs/*.json) and reject the build if there are changes.

Do this in Danger:

❯ git status --short | grep json | wc -l
       0

Raise error if products.json exists in references for configs.

There is a convention (perhaps undocumented) for prefixing release branches with release/ instead of feature/. I believe this applies to all Dangerfiles in this project.

There is currently a Dangerfile at the root of this repo that is used for gems. We should move that into a gems directory and import it into gem repos. Once gems have been updated to use this version, we need to move the incent-api Dangerfile into a services directory here, and update incent-api (as well as any service app repos) to use this new version. Once that is done, we can update Dangerfile at the root of this repo to actually check this repo. We should have four Dangerfiles when this is finished:

• ./Dangerfile
• ./gems/Dangerfile
• ./incent-config/Dangerfile
• ./services/Dangerfile

Add modified_program_sets.first after:
https://github.com/technekes/danger/blob/80f4a349b0c403de34b5fe16ea94546948dcdd0b/incent-config/Dangerfile#L69

Further discussion of troubleshooting for issue #24, it was discovered that we are running an "instance of Docker within a remote container of Docker". This is not quite desired as it makes troubleshooting and running locally, painful. Open to further discussion here.

(potentially a separate issue)
It's been proposed that we have the logic that determines the program-set in one central location so it can be used within this repository and others as to not duplicate this process.

Once the Dangerfile that is being worked on here is considered complete it should be moved here as ./incent-config/Dangerfile.

If the PR title does not contain the program-set, an unhandled error is raised. We need to check for the program-set in the branch name, and also handle the possibility that neither the PR nor the branch contains a valid program-set.

Currently the Dangerfile for incent-config will check for a branch prefix of feature/ or release/. This is a great check that should be applied to gems and services.

We are currently raising an error if a PR title does not include the program_set, but we need to change this validation so it raises an error if the PR title does not start with [program_set]

https://github.com/technekes/danger/blob/094701d5ebab826b5952d8c80bdfeba6b2664691/incent-config/Dangerfile#L153

should be changed to

unless github.pr_title.start_with?("[#{program_set}]") 
  # raise error
end