Release v0.6.0 (#134)

* Update release script

* Release v0.6.0

* Update release guide

* Update command name

Author: Zack Chase

README.md

@@ -113,48 +113,43 @@ All SDKs version on the same cadence. To publish a new version (of all SDKs), fo
 
 1.  Update the `VERSION_FROM` and `VERSION_TO` values in the `release:all` task in [`./project.json`](./project.json).
 
-1.  Leaving that single change uncommitted, make sure you've exported a GitHub access token (as `GITHUB_TOKEN` -- see below) with push access to `main` branch of the repository, then run the release script:
+1.  Leaving that single change uncommitted and run the release script:
 
     ```bash
-    npm run release
+    npm run release:create-branch
     ```
 
     This script:
 
     -   Updates the version numbers in all affected files
     -   Rebuilds all SDKs
     -   Commits all changes (e.g., to version files, lockfiles, and anything else under `./sdk`)
-    -   Adds two new tags to mark the release (`v0.0.0` and `sdk/go/v0.0.0`)
-    -   Pushes the commit and tags to GitHub, triggering the `publish` task
-    -   Creates a new GitHub release
+    -   Pushes the branch to GitHub
 
-    If for some reason the Buildkite publish job doesn't finish successfully, you can run some or all publish tasks from your local machine by exporting the applicable environment variables (again, see below), then running:
+1. Next open a PR with the created branch.
+
+1. After the PR is merged, from an up-to-date main branch, create and push the release tags:
 
     ```bash
-    npm run clean
-    npm run build
-    npm run publish                # To publish all packages
-    npx nx publish sdk/typescript  # To publish only the Node.js package
-    npx nx publish sdk/python      # To publish only the Python package
-    npx nx publish sdk/go          # To publish only the Go package
-    npx nx publish sdk/ruby        # To publish only the Ruby package
+    git tag v{VERSION_TO} main
+    git tag sdk/go/v{VERSION_TO} main
+
+    git push origin v{VERSION_TO}
+    git push origin sdk/go/v{VERSION_TO}
     ```
 
-1.  Once the `publish` job completes, verify the releases at their respective URLs:
+1. Once the tags have been created, manually trigger the SDK Release Pipeline in Buildkite. After the pipeline has finished, manually create a release in GitHub ([example](https://github.com/buildkite/buildkite-sdk/releases/tag/v0.5.0)).
+
+### Docs
 
-    -   https://github.com/buildkite/buildkite-sdk/releases
-    -   https://www.npmjs.com/package/@buildkite/buildkite-sdk
-    -   https://pypi.org/project/buildkite-sdk/
-    -   https://pkg.go.dev/github.com/buildkite/buildkite-sdk/sdk/go (this usually takes a minute or two)
-    -   https://rubygems.org/gems/buildkite-sdk
+The SDK language docs are managed by a Pulumi Program in `infra` and manually deployed after every release.
 
 ### Required environment variables
 
 The following environment variables are required for releasing and publishing:
 
--   `GITHUB_TOKEN` for creating GitHub releases (with `@octokit/rest`)
 -   `NPM_TOKEN` for publishing to npm (with `npm publish`)
 -   `PYPI_TOKEN` fror publishing to PyPI (with `uv publish`)
 -   `GEM_HOST_API_KEY` for publishing to RubyGems (with `gem push`)
 
-See the `publish:all` and `release:all` tasks in `./project.json` for details.
+See the `publish:all` tasks in `./project.json` for details.

create-release-branch.js

@@ -0,0 +1,45 @@
+const [from, to] = [process.argv[2], process.argv[3]];
+
+if (!from || !to) {
+    console.error(`Invalid 'from' or 'to' version: '${from}', '${to}'`);
+    process.exit(1);
+}
+
+(async () => {
+    const { replaceInFileSync } = await import("replace-in-file");
+    const { simpleGit } = await import("simple-git");
+    const { execSync } = await import("child_process");
+
+    const paths = [
+        "sdk/go/project.json",
+        "sdk/python/pyproject.toml",
+        "sdk/typescript/package.json",
+        "sdk/ruby/lib/buildkite/version.rb",
+        "sdk/ruby/project.json",
+    ];
+
+    const git = simpleGit();
+    const branch = `release/v${to}`;
+
+    await git.checkoutLocalBranch(branch);
+
+    // Bump versions.
+    replaceInFileSync({
+        files: paths,
+        from,
+        to,
+    });
+
+    // Build all SDKs.
+    execSync("npm run build", { stdio: "inherit" });
+
+    // Commit and tag.
+    await git.add("sdk"); // Include everything here, as lockfiles will also have changed.
+    await git.add("project.json"); // As this contains the new version.
+    await git.commit(`Release v${to}`);
+
+    // Push the commit.
+    await git.push("origin", branch);
+
+    console.log("Release branch created");
+})();

package.json

@@ -22,7 +22,7 @@
         "watch": "npx nx watch --all -- nx rebuild:all",
         "format": "npx nx format:all",
         "dev": "concurrently 'npm run docs:serve' 'npm run watch' --kill-others",
-        "release": "npx nx release:all"
+        "release:create-branch": "npx nx release:create-branch"
     },
     "private": true,
     "devDependencies": {

project.json

@@ -120,18 +120,14 @@
             "options": {
                 "commands": []
             },
-            "dependsOn": [
-                "ci:run:pipeline"
-            ]
+            "dependsOn": ["ci:run:pipeline"]
         },
         "gen:pipeline-release": {
             "executor": "nx:run-commands",
             "options": {
                 "commands": []
             },
-            "dependsOn": [
-                "ci:run:release-pipeline"
-            ]
+            "dependsOn": ["ci:run:release-pipeline"]
         },
         "build:all": {
             "dependsOn": [
@@ -192,13 +188,15 @@
         "rebuild:all": {
             "dependsOn": ["build:all", "docs:all", "run:all"]
         },
-        "release:all": {
+        "release:create-branch": {
             "executor": "nx:run-commands",
             "options": {
-                "commands": ["node ./release.js $VERSION_FROM $VERSION_TO"],
+                "commands": [
+                    "node ./create-release-branch.js $VERSION_FROM $VERSION_TO"
+                ],
                 "env": {
-                    "VERSION_FROM": "0.4.1",
-                    "VERSION_TO": "0.5.0"
+                    "VERSION_FROM": "0.5.0",
+                    "VERSION_TO": "0.6.0"
                 }
             }
         }

release.js

@@ -56,7 +56,7 @@
                 ],
                 "env": {
                     "GOPROXY": "proxy.golang.org",
-                    "VERSION": "0.5.0"
+                    "VERSION": "0.6.0"
                 }
             },
             "cache": false

sdk/go/project.json

@@ -11,7 +11,7 @@ addopts = "--cov --cov-report html:'../../../coverage/sdk/python/html' --cov-rep
 
 [project]
 name = "buildkite-sdk"
-version = "0.5.0"
+version = "0.6.0"
 description = "Automatically generated by Nx."
 requires-python = ">=3.10,<4"
 readme = "README.md"

sdk/python/pyproject.toml

@@ -1,3 +1,3 @@
 module Buildkite
-  VERSION = "0.5.0".freeze
+  VERSION = "0.6.0".freeze
 end

sdk/ruby/lib/buildkite/version.rb

@@ -48,7 +48,7 @@
                 "commands": ["gem push buildkite-sdk-$VERSION.gem"],
                 "cwd": "dist/sdks/ruby",
                 "env": {
-                    "VERSION": "0.5.0"
+                    "VERSION": "0.6.0"
                 }
             },
             "cache": false

sdk/ruby/project.json

@@ -1,6 +1,6 @@
 {
     "name": "@buildkite/buildkite-sdk",
-    "version": "0.5.0",
+    "version": "0.6.0",
     "dependencies": {
         "tslib": "^2.3.0",
         "yaml": "^2.6.1"