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

Update documentation for mindev, and add some handy debugging methods #4548

Merged
merged 2 commits into from
Sep 20, 2024

Conversation

evankanderson
Copy link
Member

Summary

While working on the PR rule types (upcoming), I started to write my own tool before being reminded of mindev. Our documentation had bit-rotted a little bit, but Jakub and Ozz helped straighten me out.

Change Type

Mark the type of change your PR introduces:

  • Bug fix (resolves an issue without affecting existing features)
  • Feature (adds new functionality without breaking changes)
  • Breaking change (may impact existing functionalities or require documentation updates)
  • Documentation (updates or additions to documentation)
  • Refactoring or test improvements (no bug fixes or new functionality)

Testing

Manual test runs like the following:

TEST_AUTH_TOKEN="$(gh auth token)" go run ./cmd/dev ruletype test -e cmd/dev/examples/repository.yaml -p ../minder-rules-and-profiles/profiles/github/ghas.yaml -r ../minder-rules-and-profiles/rule-types/github/secret_push_protection.yaml

Review Checklist:

  • Reviewed my own code for quality and clarity.
  • Added comments to complex or tricky code sections.
  • Updated any affected documentation.
  • Included tests that validate the fix or feature.
  • Checked that related changes are merged.

@coveralls
Copy link

Coverage Status

coverage: 53.449% (-0.01%) from 53.46%
when pulling 336fedf on evankanderson:cleanup-mindev
into 275579a on stacklok:main.

Copy link
Contributor

@jhrozek jhrozek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thank you, the changes to properties.go are a nice usability improvement!

@evankanderson evankanderson merged commit 25c6eaa into mindersec:main Sep 20, 2024
21 checks passed
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.

3 participants