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

Add macOS wrapper script for easy FossLight Docker execution #127

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

soonhong99
Copy link
Contributor

This PR introduces a new macOS wrapper script (fosslight_wrapper_mac.command) to simplify the process of running FossLight Scanner using Docker on macOS.

Key Features:

  • Automatic Docker image pulling (fosslight/fosslight_scanner:latest)
  • Easy execution through double-clicking the command file
  • Flexible analysis options for local directories and Git repositories
  • Custom output path selection
  • Additional FossLight options management

How to Test:

  1. Automatic Mode:

    • Place the fosslight_wrapper_mac.command file in the directory you want to analyze
    • Ensure Docker Desktop is running
    • Double-click the command file to execute
    • The script will automatically pull the required Docker image if not present
    • Analysis results will be saved in the same directory
  2. Manual Mode:

    • For custom analysis paths, output locations, or to analyze Git repositories, run:
      ./fosslight_wrapper_mac.command --manual
    • This mode allows setting custom paths and additional FossLight options

This wrapper script enhances the user experience for macOS users by providing a more accessible and user-friendly way to utilize FossLight Scanner with Docker.

Please test and provide feedback on the functionality and user experience.

Type of change

Please insert 'x' one of the type of change.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Documentation update
  • Refactoring, Maintenance
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

…tion

- Create fosslight_wrapper_mac.command script for macOS users
- Implement automatic and manual modes for flexible usage
- Add functionality to manage additional FossLight options
- Enable easy Docker image pulling and execution
- Set up GitHub Actions to include the script in releases

Signed-off-by: soonhong99 <nanayah99@naver.com>
@soimkim soimkim added the chore [PR/Issue] Refactoring, maintenance the code label Oct 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore [PR/Issue] Refactoring, maintenance the code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants