Skip to content

Back-porting new features and dependency automation to shundor/python-bandit-scan #6

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

Open
wants to merge 21 commits into
base: main
Choose a base branch
from

Conversation

reactive-firewall
Copy link

@reactive-firewall reactive-firewall commented Apr 11, 2025

Patch Notes

Back-port of new features

  • 🗒️ Introduced an optional config_path parameter for the Bandit Scan action, allowing users to specify a configuration file for command line arguments. Credit: @MrFired
  • 🤖 Automated dependency maintainability via BCP use of GitHubs own @dependabot
    • @dependabot will periodically open PRs to upgrade dependencies to help ease the workload of maintainers (eg. @abirismyname)

Fixes and Corrections

  • 🩹 Fixed an untracked issue where re-running the GitHub Action could error when attempting to upload the results.sarif artifact. Namely, added an option to overwrite existing artifacts during upload when needed. This overwrite behavior only impacts duplicates that would otherwise fail instead.
  • ✏️ Updated the usage example in the README.md to use the correct name for the shundor/python-bandit-scan GitHub Action (Hopefully this helps resolve issues like unable to find version v1 #1)
  • 🚀 Includes version bumps for action dependancies

github/code-action/upload-artifact -> v4

  • Updating to actions/upload-artifact@v4 brings significant changes we should be aware of. The maintainers have noted that version 4 introduces breaking changes:

  • GitHub Enterprise Server (GHES) Compatibility: Support for GHES versions prior to 3.5 has been discontinued. If you're using an older GHES version, this update might not be compatible.

  • Default Behavior Adjustments: There may be changes to default configurations, such as the default value for retention-days. Deprecated inputs or features might have been removed as well.

For a comprehensive understanding of these impacts and to ensure seamless integration, please review the maintainers' notes in the upload-artifact project README

Possibly Impacted GHI

Conclusion and Request for Comments

Thank you for reviewing this pull request! Your feedback is invaluable in ensuring that these changes align with the project's goals and maintain high quality.

I would especially appreciate comments from the following community members:

Please feel free to share any additional thoughts or concerns you may have. Looking forward to your feedback!

MrFired and others added 20 commits April 26, 2024 00:17
Also bind it to concrete v4 release
Development branch.
Added Updates and Automation
Bumps [github/codeql-action](https://github.com/github/codeql-action) from 2 to 3.
- [Release notes](https://github.com/github/codeql-action/releases)
- [Changelog](https://github.com/github/codeql-action/blob/main/CHANGELOG.md)
- [Commits](github/codeql-action@v2...v3)

---
updated-dependencies:
- dependency-name: github/codeql-action
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Update README.md with config for fixed version
Reduce threshold to low in example to improve default.
# Pull useful improvements from community

## Pull new configuration input feature from related work in community

* Incorporate the feature to optionally include a `config_path` input to
allow further configuration of `bandit`

## Partial version bumps for action dependancies

* Updating to `github/code-action/upload-sarif@v3` presents no
significant changes since `v2` besides the underlying node version.
Details in [relevant project
README](https://github.com/github/codeql-action?tab=readme-ov-file#supported-versions-of-the-codeql-action)

* Updating to `actions/upload-artifact@v4` brings significant changes we
should be aware of. The maintainers have noted that version 4 introduces
breaking changes:

* **GitHub Enterprise Server (GHES) Compatibility**: Support for GHES
versions prior to 3.5 has been discontinued. If you're using an older
GHES version, this update might not be compatible.
* **Default Behavior Adjustments**: There may be changes to default
configurations, such as the default value for retention-days. Deprecated
inputs or features might have been removed as well.

For a comprehensive understanding of these impacts and to ensure
seamless integration, please review the maintainers' notes in the
[upload-artifact project
README](https://github.com/actions/upload-artifact#actionsupload-artifact)

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **New Features**
- Introduced an optional `config_path` parameter for the Bandit Scan
action, allowing users to specify a configuration file for command line
arguments.

- **Improvements**
- Updated artifact upload steps to use the latest versions of the
actions, enhancing reliability and functionality.
	- Added an option to overwrite existing artifacts during upload.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
…ity features

> [!NOTE]
> 
> Due to the backup, upstream with
[actions/starter-workflows#2497](actions/starter-workflows#2497)
not yet resolved, this PR will include at-least two minor version bumps:
> 
> *
[v2.2](637c5c4)
@
[637c5c4](637c5c4)
> *
[v2.3](f8cf05e)
@
[f8cf05e](f8cf05e)

---
* main:
  re:re:re updated the usage example in the README.md
  Update README.md
  Update README.md
  Update name in action.yml
  [UPDATE] (deps): Bump github/codeql-action from 2 to 3
  Update README.md
  Allow config file specification
  Upgrade upload-serif action to v3
  Fix breaking changes in upload-artifact action use
…t-scan for use by shundor/python-bandit-scan
@reactive-firewall reactive-firewall marked this pull request as ready for review April 11, 2025 23:45
@reactive-firewall reactive-firewall marked this pull request as draft April 11, 2025 23:46
* Oops! :hear_not_evil: The labels must already be present in the github project settings. (FIXED)
* I also don't have write-access so I removed myself from the default assignee; this simplifies the configuration.

These are not user-facing changes.
@reactive-firewall reactive-firewall marked this pull request as ready for review April 12, 2025 00:04
Copy link
Contributor

@SamMorrowDrums SamMorrowDrums left a comment

Choose a reason for hiding this comment

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

Looks great to me

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.

unable to find version v1
3 participants