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

Development Documentation Out of Date? #1234

Closed
shanedell opened this issue Apr 13, 2023 · 1 comment · Fixed by #1384
Closed

Development Documentation Out of Date? #1234

shanedell opened this issue Apr 13, 2023 · 1 comment · Fixed by #1384
Labels
changelog-ignore Don't include this issue in the release changelog

Comments

@shanedell
Copy link
Contributor

What happened:

DEVELOPING.md seems to be out dated. Believe this is because these commands are inside the Docker Development section:

docker-compose build grype
docker-compose run --rm grype bash

However, there is no docker-compose.yml inside of the repo.

Also when trying to use docker commands:

docker build -t grype -f Dockerfile .
docker run --rm grype bash

An error like this below is returned:

docker: Error response from daemon: failed to create shim task: OCI runtime create failed: runc create failed: unable to start container process: exec: "/grype": stat /grype: no such file or directory: unknown.

So the build works but not the run

What you expected to happen:

Does the development README need updated? I would have expected docker run --rm grype bash to work after building the image so maybe I also missing something there.

This really isn't necessarily a bug more of documentation question to help me get setup locally but I wasn't sure what category to pick.

@shanedell shanedell added the bug Something isn't working label Apr 13, 2023
@tgerla tgerla added this to OSS Apr 20, 2023
@tgerla
Copy link
Contributor

tgerla commented Apr 20, 2023

Hi @shanedell, thanks for the issue. You're right that the DEVELOPING.md document needs to be updated, since we are no longer using docker-compose. For your second question, this method with Docker isn't really a supported way of developing Grype. For the most part we use go run ./main.go for development. Will that get you going for now? Thanks!

@tgerla tgerla moved this to Awaiting Response in OSS Apr 20, 2023
@willmurphyscode willmurphyscode added changelog-ignore Don't include this issue in the release changelog and removed bug Something isn't working labels Jul 11, 2023
@github-project-automation github-project-automation bot moved this from Awaiting Response to Done in OSS Jul 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog-ignore Don't include this issue in the release changelog
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

3 participants