Merge pull request #14 from DataDog/anmarchenko/releases

[SDTEST-2716] Add release workflows

Author: anmarchenko

.github/workflows/prerelease.yml

@@ -0,0 +1,33 @@
+name: Pre-Release
+
+on:
+  push:
+    branches: [main]
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+
+      - name: Set up Go
+        uses: actions/setup-go@c0137caad775660c0844396c52da96e560aba63d # v5
+        with:
+          go-version: '1.25'
+
+      - name: Build binaries
+        run: make release
+
+      - name: Create Release and Upload Assets
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          SHORT_SHA=$(git rev-parse --short HEAD)
+          gh release create "pre-release-$SHORT_SHA" \
+            --title "Pre-release $SHORT_SHA" \
+            --prerelease \
+            dist/*

.github/workflows/release.yml

@@ -2,7 +2,8 @@ name: Release
 
 on:
   push:
-    branches: [main]
+    tags:
+      - 'v*'
 
 jobs:
   release:
@@ -17,7 +18,7 @@ jobs:
       - name: Set up Go
         uses: actions/setup-go@c0137caad775660c0844396c52da96e560aba63d # v5
         with:
-          go-version: "1.25"
+          go-version: '1.25'
 
       - name: Build binaries
         run: make release
@@ -26,8 +27,19 @@ jobs:
         env:
           GH_TOKEN: ${{ github.token }}
         run: |
-          SHORT_SHA=$(git rev-parse --short HEAD)
-          gh release create "pre-release-$SHORT_SHA" \
-            --title "Pre-release $SHORT_SHA" \
-            --prerelease \
+          TAG_NAME=${GITHUB_REF#refs/tags/}
+          gh release create "$TAG_NAME" \
+            --title "$TAG_NAME" \
+            --draft \
+            --generate-notes \
             dist/*
+
+      - name: Print Release Summary
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          TAG_NAME=${GITHUB_REF#refs/tags/}
+          RELEASE_URL=$(gh release view "$TAG_NAME" --json url --jq .url)
+          echo "## Release Created! 🎉" >> $GITHUB_STEP_SUMMARY
+          echo "" >> $GITHUB_STEP_SUMMARY
+          echo "Please review and publish the release! Here is the link: $RELEASE_URL" >> $GITHUB_STEP_SUMMARY

README.md

@@ -1,6 +1,6 @@
 # DDTest
 
-DDTest is a single‑binary CLI that plans and runs your tests in parallel alongside your existing test commands — or as a drop‑in runner. It discovers the tests in your repo, fetches Datadog Test Optimization data, configures your CI to use the right number of workers, and distributes test execution across workers.
+DDTest is a CLI tool that plans and runs your tests in parallel alongside your existing test commands - or as a drop‑in runner. It discovers the tests in your repo, fetches Datadog Test Optimization data, configures your CI to use the right number of workers, and distributes test execution across workers.
 
 You need it when Test Impact Analysis shrinks the test workload but CI still launches too many nodes, and skipped tests leave splits wildly uneven. Start by generating a plan (`ddtest plan`) you can feed to any runner, or let DDTest execute the tests for you with `ddtest run` in CI.
 
@@ -19,9 +19,15 @@ cd ddtest && make build
 
 This will create the `ddtest` binary in the current directory. It requires Go 1.24+.
 
+## Prerequisites
+
+Before using DDTest, you must have **Datadog Test Optimization** already set up and enabled with a Datadog Test Optimization library for your language and framework. DDTest relies on this integration to discover your tests and plan test execution accordingly.
+
+For instructions on setting up Test Optimization, see the [Datadog Test Optimization documentation](https://docs.datadoghq.com/tests/setup/).
+
 ## Usage
 
-DDTest ships as a single CLI with two primary sub‑commands: `plan` and `run`.
+DDTest ships as a CLI tool `ddtest` with two primary sub‑commands: `plan` and `run`.
 
 Use `plan` to discover tests, fetch Datadog Test Optimization data once, and compute a parallelization plan you can reuse on any CI node; use `run` to execute that plan locally or in CI. If a plan is missing, `run` will generate it on the fly.