Skip to content

v0.41.0
Compare
Choose a tag to compare
@actions-helper actions-helper released this 14 Jun 00:23
· 8 commits to main since this release
v0.41.0
cba32c3

v0.41.0 (2024-06-14)

Documentation

  • docs: added windows set up documentation (#566)

secureli-XXX

This change adds the setup steps for contributors using windows machines

Changes

Added windows developer configuration information to contributing.md

Testing

<!--
Mention updated tests and any manual testing performed.
Are aspects not yet tested or not easily testable?
Feel free to include screenshots if appropriate.
-->
*

Clean Code Checklist

<!-- This is here to support you. Some/most checkboxes may not apply to
your change -->

  • Meets acceptance criteria for issue
  • New logic is covered with automated tests
  • Appropriate exception handling added
  • Thoughtful logging included
  • Documentation is updated
  • Follow-up work is documented in TODOs
  • TODOs have a ticket associated with them
  • No commented-out code included

<!--
Github-flavored markdown reference:
https://docs.github.com/en/get-started/writing-on-github
-->

Co-authored-by: Ian Bowden <ian.bowden@slalom> (730fe09)

  • docs: Feature/secureli 488 update documentation with new features (#563)

secureli-488

Updating documentation for various features

Note this is branched off
feature/secureli-397-document-config-file-usage, as that hasn't yet
been merged and adds table of contents to the markdown files which
needed to be updated as part of this.

Changes

  • Updated docstrings to provide hints about function parameters which
    hadn't been documented when they were added
  • Added info to README.md on some features
  • Moved language support information from CONTRIBUTING.md to
    README.md

Clean Code Checklist

<!-- This is here to support you. Some/most checkboxes may not apply to
your change -->

  • Meets acceptance criteria for issue
  • New logic is covered with automated tests
  • Appropriate exception handling added
  • Thoughtful logging included
  • Documentation is updated
  • Follow-up work is documented in TODOs
  • TODOs have a ticket associated with them
  • No commented-out code included

<!--
Github-flavored markdown reference:
https://docs.github.com/en/get-started/writing-on-github
--> (46855c9)

  • docs: Added info on repo-config.yaml and tables of contents (#562)

secureli-397

Issue was for adding documentation about config files. There wasn't much
more that needed to be added in that regard. I also added tables of
contents to README.md and CONTRIBUTING.md. The tables of contents
were generated with the VSCode plugin Markdown All in
One.

Changes

  • Added section describing the nature of repo-config.yaml
  • Added tables of contents to README.md and CONTRIBUTING.md

Testing

  • n/a

Clean Code Checklist

<!-- This is here to support you. Some/most checkboxes may not apply to
your change -->

  • Meets acceptance criteria for issue
  • New logic is covered with automated tests
  • Appropriate exception handling added
  • Thoughtful logging included
  • Documentation is updated
  • Follow-up work is documented in TODOs
  • TODOs have a ticket associated with them
  • No commented-out code included

<!--
Github-flavored markdown reference:
https://docs.github.com/en/get-started/writing-on-github
--> (587deec)

  • docs: secureli 540 update documentation (#560)

secureli-540

This ticket was about a problem with configuring the pre-commit library.
I determined that the issue was due to misconfiguration by the user, and
the solution we settled on was to add documentation about how to specify
args in the pre-commit library's configuration file.

Additionally, I updated headings throughout the file. Previously there
were multiple H1s, and the License section was nested underneath the
Configuration section. I've updated it so that there is only a single H1
heading--the title of the document--and the License section is now a
sibling of configuration instead of a child.

Changes

  • Updated headings throughout the file
  • Added information and links for the pre-commit library
  • Added information about a quirk of how pre-commit handles parameters
    that take arguments

Testing

  • All changes are in documentation; no testing required or possible

Clean Code Checklist

  • Meets acceptance criteria for issue
  • New logic is covered with automated tests
  • Appropriate exception handling added
  • Thoughtful logging included
  • Documentation is updated
  • Follow-up work is documented in TODOs
  • TODOs have a ticket associated with them
  • No commented-out code included (b48109c)

Feature

  • feat: Added functionality to specify a custom scan when using the scan command (#565)

secureli-XXX

<!-- Include general description here -->

Changes

This PR improves the scan action by adding new functionality allowing
users to specify a custom scan id instead of only being able to specify
pre-commit hook ids. For example, you can now do secureli scan -t check-pii to run the pii scan.

A new service was introduced, CustomScannersService to help orchestrate
which custom scans should be run. Either a specific scan if an Id is
specified, all custom scans if no id is specified, or a None result is
returned if the specified id doesn't match a value in the new
CustomScanId enum. 

There was also some refactoring done.
modules/core/core_services/scanner.py is now
modules/core/core_services/hook_scanner.py to more accurately
describe its function. The pii scanner and custom_regex_scanner
directories have been moved into a new directory;
secureli/modules/custom_scanners/

Testing

Added unit tests and performed manual testing to confirm that pre-commit
hooks can be specified, custom scans can be specified, and when no id is
specified, then all scans are done

Clean Code Checklist

<!-- This is here to support you. Some/most checkboxes may not apply to
your change -->

  • Meets acceptance criteria for issue
  • New logic is covered with automated tests
  • Appropriate exception handling added
  • Thoughtful logging included
  • Documentation is updated
  • Follow-up work is documented in TODOs
  • TODOs have a ticket associated with them
  • No commented-out code included

<!--
Github-flavored markdown reference:
https://docs.github.com/en/get-started/writing-on-github
-->

Co-authored-by: Ian Bowden <ian.bowden@slalom> (385803d)

Unknown

  • Feature/secureli 460 custom regex (#564)

secureli-460

Adds new new-pattern parameter to secureli update and updates
secureli scan to check for custom regex

Changes

Testing

<!--
Mention updated tests and any manual testing performed.
Are aspects not yet tested or not easily testable?
Feel free to include screenshots if appropriate.
-->

  • run secureli update --new-pattern &lt;custom-regex-pattern&gt;
  • verify that your custom regex pattern was added to .secureli.yaml
  • modify any file (other than .secureli.yaml) to include text that
    matches your custom regex
  • stage the changes
  • run secureli scan and verify the scan fails
  • revert the changes and run secureli scan and verify the scan passes

Clean Code Checklist

<!-- This is here to support you. Some/most checkboxes may not apply to
your change -->

  • Meets acceptance criteria for issue
  • New logic is covered with automated tests
  • [ x Appropriate exception handling added
  • Thoughtful logging included
  • Documentation is updated
  • Follow-up work is documented in TODOs
  • TODOs have a ticket associated with them
  • No commented-out code included

<!--
Github-flavored markdown reference:
https://docs.github.com/en/get-started/writing-on-github
-->

Co-authored-by: Rachel Teal <[email protected]> (1917cca)

Assets 4
Loading