From 3d59697b721ca3dd9a4a66a2e9cac615bced90fd Mon Sep 17 00:00:00 2001 From: Keren Reshef Date: Mon, 11 Nov 2024 11:32:13 +0200 Subject: [PATCH] Fix release workflow and updated README file (#46) Fix release workflow and updated README file --- .github/workflows/release.yml | 34 +++++++++--------- README.md | 66 ++++++++++++----------------------- 2 files changed, 39 insertions(+), 61 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 149110c..fc872cd 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -21,24 +21,27 @@ jobs: - name: Checkout Code uses: actions/checkout@v4 with: - ref: master - - - name: Merge dev into master - run: | - git pull origin master - git fetch --all - git merge origin/dev + ref: dev - name: Update VSIX Version in manifest file run: .\scripts\UpdateVsixVersion.ps1 shell: pwsh + - - name: Commit and push changes + - name: Commit changes run: | git add . git commit -m "Updated VSIX version to ${{ env.NEW_VERSION }}" git push + - name: Merge dev into master + run: | + git fetch --all + git checkout master + git pull origin master + git merge origin/dev + git push + call-build-workflow: # build and package the vsix project uses: ./.github/workflows/build-vsix.yml @@ -69,13 +72,10 @@ jobs: # upload the vsix and manifest files to Visual Studio Marketplace using VsixPublisher - name: Publish to Visual Studio Marketplace - env: - # vsix publisher executable is already installed in the github windows runner at the following path - VSIX_PUBLISHER_PATH: "C:/Program Files/Microsoft Visual Studio/2022/Enterprise/VSSDK/VisualStudioIntegration/Tools/Bin/VsixPublisher.exe" - VSIX_PATH: "./JFrogVSExtension/bin/Release/JFrogVSExtension.vsix" - PUBLISH_MANIFEST_PATH: "./JFrogVSExtension/PublishManifest.json" + # vsix publisher executable is already installed in the github windows runner at the following path run: | - $Env:VSIX_PUBLISHER_PATH publish ` - -payload $Env:VSIX_PATH ` - -publishManifest $Env:PUBLISH_MANIFEST_PATH ` - -personalAccessToken ${{ secrets.VS_MARKETPLACE_PAT }} \ No newline at end of file + $VSIX_PUBLISHER_PATH = "C:/Program Files/Microsoft Visual Studio/2022/Enterprise/VSSDK/VisualStudioIntegration/Tools/Bin/VsixPublisher.exe" + $VSIX_PATH = "./JFrogVSExtension/bin/Release/JFrogVSExtension.vsix" + $PUBLISH_MANIFEST_PATH = "./JFrogVSExtension/PublishManifest.json" + & $VSIX_PUBLISHER_PATH publish -payload $VSIX_PATH -publishManifest $PUBLISH_MANIFEST_PATH -personalAccessToken ${{ secrets.VS_MARKETPLACE_PAT }} + shell: pwsh \ No newline at end of file diff --git a/README.md b/README.md index 85e1e13..c891eb1 100644 --- a/README.md +++ b/README.md @@ -1,49 +1,27 @@ -# JFrog Visual Studio Extension +# JFrog Visual Studio Extension +[![Scanned by Frogbot](https://raw.github.com/jfrog/frogbot/master/images/frogbot-badge.png)](https://github.com/jfrog/frogbot#readme) + | Target | Status | Installs | |:------------------------:|:-----------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| Visual Studio 2022 | [![Visual Studio 2022](https://vsmarketplacebadge.apphb.com/version/JFrog.JFrogV2.svg)](https://marketplace.visualstudio.com/items?itemName=JFrog.JFrogV2) | ![Artifactory Extension Marketplace Installs](https://img.shields.io/visual-studio-marketplace/i/JFrog.JFrogV2?label=marketplace%20installs&color=blue&style=for-the-badge) | -| Visual Studio 2017, 2019 | [![Visual Studio 2017,2019](https://vsmarketplacebadge.apphb.com/version/JFrog.JFrog.svg)](https://marketplace.visualstudio.com/items?itemName=JFrog.JFrog) | ![Visual Studio 2017,2019](https://img.shields.io/visual-studio-marketplace/i/JFrog.JFrog?label=marketplace%20installs&color=blue&style=for-the-badge) | - - -# Table of Contents - -- [About this Extension](#about-this-extension) - - [Component Tree Icons](#component-tree-icons) -- [Installing the Extension](#installing-the-extension) -- [Building the Sources](#building-the-sources) -- [Troublshooting Issues](#troublshooting-issues) -- [Release Notes](#release-notes) -- [Code Contributions](#code-contributions) - -## About this Extension -JFrog Visual studio extension adds JFrog Xray scanning of NuGet project dependencies to your Visual Studio. -To learn how to use the extension, please visit the [JFrog Visual Studio Extension User Guide](https://www.jfrog.com/confluence/display/XRAY/IDE+Integration#IDEIntegration-JFrogVisualStudioExtension). - -### Component Tree Icons -The icon demonstrates the top severity issue of a selected component and its transitive dependencies. The following table describes the severities from lowest to highest: -| Icon | Severity | Description | -|:-----------------------------------:|:--------:|:---------------------------------------------------------------------------------------| -| ![Normal](JFrogVSExtension/Resources/normal.png) | Normal | Scanned - No Issues | -| ![Unknown](JFrogVSExtension/Resources/unknown.png) | Unknown | No CVEs attached to the vulnerability or the selected component not identified in Xray | -| ![Low](JFrogVSExtension/Resources/low.png) | Low | Top issue with low severity | -| ![Medium](JFrogVSExtension/Resources/medium.png) | Medium | Top issue with medium severity | -| ![High](JFrogVSExtension/Resources/high.png) | High | Top issue with high severity | -| ![Critical](JFrogVSExtension/Resources/critical.png) | Critical | Top issue with critical severity - -## Installing the Extension -1. Make sure nuget.exe exists under your PATH environment variable -2. Open Visual Studio -3. Open *Tools* --> *Extensions and Updates* - -![alt](docs/images/getTools.png) - -4. Search for JFrog Visual Studio Extension -5. Click on *Download* -6. Once the installation is completed, re-open Visual Studio. - -## Release Notes +| Visual Studio 2022 | [Visual Studio 2022](https://marketplace.visualstudio.com/items?itemName=JFrog.JFrogV2) | ![Artifactory Extension Marketplace Installs](https://img.shields.io/visual-studio-marketplace/i/JFrog.JFrogV2?label=marketplace%20installs&color=blue&style=for-the-badge) | +| Visual Studio 2017, 2019 | [Visual Studio 2017,2019](https://marketplace.visualstudio.com/items?itemName=JFrog.JFrog) | ![Visual Studio 2017,2019](https://img.shields.io/visual-studio-marketplace/i/JFrog.JFrog?label=marketplace%20installs&color=blue&style=for-the-badge) | + + +| Branch | Status | +|:------:|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| +| master | [![Test](https://github.com/jfrog/jfrog-visual-studio-extension/actions/workflows/tests.yml/badge.svg?branch=master)](https://github.com/jfrog/jfrog-visual-studio-extension/actions/workflows/tests.yml?query=branch%master) | +| dev | [![Test](https://github.com/jfrog/jfrog-visual-studio-extension/actions/workflows/tests.yml/badge.svg?branch=dev)](https://github.com/jfrog/jfrog-visual-studio-extension/actions/workflows/tests.yml?query=branch%3Adev) | + +## 🤖 About this Extension +The JFrog Visual Studio Extension adds JFrog Xray scanning of NuGet project dependencies to your Visual Studio IDE. It allows developers to view panels displaying vulnerability information about the components and their dependencies directly in Visual Studio. With this information, a developer can make an informed decision on whether to use a component or not before it gets entrenched into the organization’s product. The extension filter allows you view the scanned results according to issues.
+To learn how to use the extension, please visit the [JFrog Visual Studio Extension User Guide](https://jfrog.com/help/r/jfrog-integrations-documentation/jfrog-visual-studio-extension). + +## 🥏 Release Notes The release notes are available [here](https://github.com/jfrog/jfrog-visual-studio-extension/releases). -## Code Contributions -We welcome community contribution through pull requests. +## 🔥 Reporting Issues +Please help us improve by reporting issues you encounter [here](https://github.com/jfrog/jfrog-visual-studio-extension/issues). + +## 💻 Contributions +We welcome community contribution through pull requests. To help us improve this project, please read our [Contribution](https://github.com/jfrog/jfrog-visual-studio-extension/blob/master/CONTRIBUTING.md) guide.