Automatically Generated Indexes

[mbellifa]

Background

Previously we generated the data for the Detection Coverage page manually. These changes aim to automate this generation as well as the markdown indexes in the /indexes/ folder.

Changes

• Adds steps to the release workflow which generates a detection-coverage.json and markdown indexes when a release is cut, which is then written back to the repo.
• Indexes now link to the YAML file rather than the associated Python code as they previously did

Testing

• It was difficult to fully test this since my fork doesn't have access to the same secrets. I made a branch with a modified workflow that commented out the portions requiring secrets. For example, this run does not use the Panther Bot secret.
  • Branch
  • Successful run
  • Commit from run
• I'm not sure if this method of writing back to the repo will work with code signing, let me know if you'd like me to try a different method
• Note that the workflow changes happen before the actual release is cut, so it may block the release process if it errors

[le4ker]

Can we add the no-sign flag, like Christos did here?

[mbellifa]

Thanks for taking a look. I've added the flag.

[le4ker]

@mbellifa we can't run this workflow before merging it, because it has been opened from a fork. Can you open this PR from withing panther-analysis? This will allow us to run the workflow from the panther-analysis branch, which will verify whether it works or not.

[mbellifa]

Sounds good, @le4ker. I've raised #1472 as a non-fork version and I'll close this one.