diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..7775826 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,76 @@ +--- +name: "๐Ÿ› Bug Report" +description: Create a report to help us improve +labels: [ bug ] +body: + - type: textarea + id: description + attributes: + label: Describe the bug + description: What is the problem? A clear and concise description of the bug. + validations: + required: true + + - type: textarea + id: current + attributes: + label: Current behavior + description: | + Please include full errors, uncaught exceptions, screenshots, and relevant logs. + Logs can be found under '/Users//.jfrog-docker-desktop-extension/logs' + validations: + required: true + + - type: textarea + id: reproduction + attributes: + label: Reproduction steps + description: | + Provide steps to reproduce the behavior. + validations: + required: false + + - type: textarea + id: expected + attributes: + label: Expected behavior + description: | + What did you expect to happen? + validations: + required: false + + - type: input + id: docker-version + attributes: + label: Docker Client and Desktop info + description: using 'docker version' command on your CLI + validations: + required: true + + - type: input + id: jfrog-docker-version + attributes: + label: JFrog Docker Desktop Extension version + validations: + required: true + + - type: input + id: os-version + attributes: + label: Operating system type, architecture and version + validations: + required: true + + - type: input + id: cli-version + attributes: + label: JFrog CLI version + validations: + required: false + + - type: input + id: xr-version + attributes: + label: JFrog Xray version + validations: + required: false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..8742036 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,5 @@ +- [ ] All [tests](https://github.com/jfrog/jfrog-docker-desktop-extension#tests) passed. If this feature is not already covered by the tests, I added new tests. +- [ ] This pull request is on the dev branch. +- [ ] I used "yarn lint" for formatting the code before submitting the pull request. +- [ ] Update [documentation](https://github.com/jfrog/documentation) about new features / new supported technologies +--- diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..6494b1e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,56 @@ +# Guidelines +## Prerequisites +Make sure you have these tools on your computer: +- yarn 1.x.x +- docker +- docker for windows + +#### Make sure to run the all the "make" commands from the root directory of the project repository. + +### Adding Tests + +If the existing tests do not already cover your changes, please add tests. + +## Building and running the project locally +To build and run the plugin, follow these steps: +1. Clone the code from this git repository https://github.com/jfrog/jfrog-docker-desktop-extension +2. Run this command to build the image locally: + ```bash + make build-extension + ``` +3. Run this command to install the extension on your docker desktop: + + ```bash + make install-extension + ``` +4. Make sure the checkbox labeled "Allow only extensions distributed through Docker Marketplace" is unchecked: + ![Alt text](resources/screenshots/7.png) +5. Go to "My Extensions" tab on docker desktop and press Open": + ![Alt text](resources/screenshots/8.png) + + +You can now use the extension locally on your docker desktop! + +## Updating and debugging code + +- To update the extension to include new code run: + ```bash + make update + ``` +- To debug the code run: + ```bash + make debug + ``` +- To stop debugging run: + ```bash + make stop-debug + ``` + +## Publishing + +To publish new code run this command: + +- Pushes the image with the latest tag: +```bash +make release +``` \ No newline at end of file diff --git a/Dockerfile b/Dockerfile index 378ffc9..db2b995 100644 --- a/Dockerfile +++ b/Dockerfile @@ -4,7 +4,7 @@ RUN curl -sL https://deb.nodesource.com/setup_16.x | bash - RUN apt-get install -y nodejs RUN npm install -g yarn WORKDIR /host -ARG jfrogCliVersion=2.25.1 +ARG jfrogCliVersion=2.64.0 ARG TARGETARCH RUN if [ "$TARGETARCH" = "arm64" ]; then \ curl -XGET "https://releases.jfrog.io/artifactory/jfrog-cli/v2-jf/$jfrogCliVersion/jfrog-cli-mac-arm64/jf" -L -k -g > jf-darwin; \ @@ -45,7 +45,9 @@ LABEL org.opencontainers.image.title="JFrog" \ com.docker.extension.detailed-description="

The JFrog Docker Desktop Extension scans any of your local Docker images for security vulnerabilities. The scanning process is based on JFrog Xray's vast vulnerabilities database, which is continuously updated with the latest vulnerabilities. In addition, a dedicated Security Research Team within JFrog, continuously improves the JFrog Xray's detection methods, ensuring that Xray continues to be a leading security solution in the market.

Deep recursive scanning

When an image is scanned with the JFrog Extension, Xray recursively scans every package included in the Docker Image. Drilling down to analyze even the smallest binary component that affects your software. For example, when analyzing a Docker image, if Xray finds that it contains a Java application it will also analyze all the .jar files used in this application.

Fixed versions

The JFrog Extension not only allows the detection of vulnerable packages, but also displays the software versions that include the fixes, allowing you to upgrade the vulnerable packages and resolve the issue.

Easy and intuitive interface

When clicking on a specific vulnerability, the view is expanded, to also include the issue description, online references about the issue, and a graph showing the location of the vulnerability within the image.

It is all available for free

Using the JFrog Extension doesn't require a paid JFrog subscription. You can use your own existing JFrog environment, or set up a new one in just two steps.

" \ com.docker.extension.publisher-url="https://jfrog.com" \ com.docker.extension.additional-urls="[{\"title\":\"Documentation\",\"url\":\"https://github.com/jfrog/jfrog-docker-desktop-extension#readme\"},{\"title\":\"Source code\",\"url\":\"https://github.com/jfrog/jfrog-docker-desktop-extension\"},{\"title\":\"JFrog Xray documentation\",\"url\":\"https://www.jfrog.com/confluence/display/JFROG/JFrog+Xray\"}]" \ - com.docker.extension.changelog="

Exciting New Features๐ŸŽ‰