Merge pull request #69 from codacy/resume-releases

breaking: Resume CLI releases

Author: machadoit

.github/workflows/go.yml

@@ -94,31 +94,31 @@ jobs:
       #     Write-Host "Attempting to run CLI..."
       #     .\cli-v2.exe install
 
-## For now we are not releasing the CLI, as we are making some quicker iterations
-  # release:
-  #   needs: [test, ittest]
-  #   if: github.ref == format('refs/heads/{0}', github.event.repository.default_branch) && github.event_name == 'push'
-  #   runs-on: ubuntu-latest
-  #   steps:
-  #     - name: Checkout
-  #       uses: actions/checkout@v4
-  #       with:
-  #         fetch-depth: 0
-  #     - name: Set up Go
-  #       uses: actions/setup-go@v4
-  #     - name: "Git Version"
-  #       id: generate-version
-  #       uses: codacy/[email protected]
-  #     - name: "Tag version"
-  #       run: |
-  #         git tag ${{ steps.generate-version.outputs.version }}
-  #         git push --tags "https://codacy:${{ secrets.GITHUB_TOKEN }}@github.com/codacy/codacy-cli-v2"
-  #     - name: Run GoReleaser
-  #       uses: goreleaser/goreleaser-action@v5
-  #       with:
-  #         distribution: goreleaser
-  #         # 'latest', 'nightly', or a semver
-  #         version: "latest"
-  #         args: release --clean
-  #       env:
-  #         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+# For now we are not releasing the CLI, as we are making some quicker iterations
+  release:
+    needs: [test, ittest]
+    if: github.ref == format('refs/heads/{0}', github.event.repository.default_branch) && github.event_name == 'push'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Set up Go
+        uses: actions/setup-go@v4
+      - name: "Git Version"
+        id: generate-version
+        uses: codacy/[email protected]
+      - name: "Tag version"
+        run: |
+          git tag ${{ steps.generate-version.outputs.version }}
+          git push --tags "https://codacy:${{ secrets.GITHUB_TOKEN }}@github.com/codacy/codacy-cli-v2"
+      - name: Run GoReleaser
+        uses: goreleaser/goreleaser-action@v5
+        with:
+          distribution: goreleaser
+          # 'latest', 'nightly', or a semver
+          version: "latest"
+          args: release --clean
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -94,6 +94,14 @@ To upload a SARIF file to Codacy:
 codacy-cli upload -s path/to/your.sarif -c your-commit-uuid -t your-project-token
 ```
 
+## Breaking Changes
+
+Some behaviors have changed with the new updates of the CLI. To rely on a specific version, you can add that version to your environment:
+
+```
+export CODACY_CLI_V2_VERSION="1.0.0-main.133.3607792"
+```
+
 ### Example Repository
 
 As an example, you can check https://github.com/troubleshoot-codacy/eslint-test-examples for a repository that has an action relying on this CLI.