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

[Installer] Add anchore/syft #25

Open
11 tasks
joshsleeper opened this issue Dec 16, 2022 · 3 comments · May be fixed by webinstall/webi-installers#809
Open
11 tasks

[Installer] Add anchore/syft #25

joshsleeper opened this issue Dec 16, 2022 · 3 comments · May be fixed by webinstall/webi-installers#809
Labels
first-timers-only Alias for 'good first issue' good first issue Good for newcomers hacktoberfest Hacktoberfest contest alias for 'good first issue' up-for-grabs Alias for 'good first issue'

Comments

@joshsleeper
Copy link

Add anchore/syft

We want to add anchore/syft because...

  • it works consistently across Windows, Mac, and Linux.
  • syft is a CLI tool from Anchore for generating SBOMs from a container or filesystem

This could be as simple as copying _example, updating the github releases
info, and doing a find and replace on a few file system path names.

How to create a webi installer

Video Tutorial: How to create a webi Installer

Skills required

  • Basic Command Line knowledge (mkdir, mv, ls, tar, unzip, variables)

Steps

  1. Clone and setup the webi packages repo
    git clone git@github.com:webinstall/packages.git
    pushd packages/
    npm install
  2. Copy the example template and update with info from Official Releases:
    https://github.com/anchore/syft/releases
    rsync -av _example/ syft/
    • update syft/release.js to use the official repo
    • Learn how syft unpacks (i.e. as a single file? as a .tar.gz? as
      a .tar.gz with a folder named syft?)
    • find and replace to change the name
      • update syft/install.sh (see bat and jq as examples)
      • update syft/install.ps1 (see bat and jq as examples)
  3. Needs an updated tagline and cheat sheet
    • update syft/README.md
      • official URL
      • tagline
      • Switch versions
      • description / summary
      • General pointers on usage (and perhaps "gotchas")

It's also okay to have multiple people work on part of this (i.e. the Cheat
Sheet can be done independently from the install.sh)

@joshsleeper joshsleeper added the good first issue Good for newcomers label Dec 16, 2022
@cybraia
Copy link

cybraia commented Dec 26, 2022

Hi! I would like to work on this issue. Could you please assign this to me? Also, I am a first timer, I need some guidance on the changes I need to make. Any help would be appreciated. Thanks!

@coolaj86
Copy link
Member

coolaj86 commented Jan 6, 2023

@cybraia go ahead. Take a look at the video above ^^.
@joshsleeper Could you cook up the cheat sheet for this as well (you can see the README.md for just about any of the install folders for a decent example)

@coolaj86 coolaj86 transferred this issue from webinstall/webi-installers Oct 12, 2023
@coolaj86 coolaj86 added first-timers-only Alias for 'good first issue' up-for-grabs Alias for 'good first issue' hacktoberfest Hacktoberfest contest alias for 'good first issue' labels Oct 16, 2023
@joshsleeper
Copy link
Author

alright, finally got around to getting an MR opened for this

webinstall/webi-installers#809

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
first-timers-only Alias for 'good first issue' good first issue Good for newcomers hacktoberfest Hacktoberfest contest alias for 'good first issue' up-for-grabs Alias for 'good first issue'
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants