Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Automatically Generated Indexes #1465

Open
wants to merge 7 commits into
base: develop
Choose a base branch
from

Conversation

mbellifa
Copy link
Contributor

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.
  • 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

@mbellifa mbellifa requested a review from a team as a code owner January 10, 2025 01:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant