Add workflow to branch for next OSS release. Fixes #16

Author: ryanjbaxter

.github/actions/add-branches-projects-json/README.md

@@ -0,0 +1,70 @@
+# add-branches-projects-json
+
+Registers newly created release line branches in
+[`config/projects.json`](../../../config/projects.json), so scheduled builds start
+covering them.
+
+The mirror image of
+[`retire-branch-projects-json`](../retire-branch-projects-json/README.md), and it
+resolves the project entry and section the same way. It takes the whole set of
+branches for a release train **at once**: a train rollover touches ~30 repositories,
+and doing this inside a matrix would have those jobs racing to push to this
+repository's `main`.
+
+## Behaviour
+
+For each addition, the project key comes from the repository name (org prefix and
+`-commercial` suffix stripped) and the section from the suffix — `commercial` for
+`-commercial` repositories, `oss` for everything else. Then:
+
+1. The branch is added to the front of `<section>.branches.scheduled` if it is not
+   already there.
+2. `<section>.jdkVersions[branch]` is set to a **copy** of the source branch's list,
+   falling back to the section's `default`, then to the matching section of the
+   global `defaults` entry, then to `["17", "21"]`.
+3. `branches.default` is left alone. A new release line branch is a maintenance
+   line; the branch it was cut from stays the default.
+4. A project with no entry in `projects.json` gets one, deep-copied from
+   `defaults.<section>`. It is copied rather than shared on purpose:
+   `update-projects-json` hands out the shared `defaults` object and then mutates
+   it, silently rewriting the fallback every other project relies on.
+
+Every step is a no-op when it has already been applied, so a re-run of a partially
+successful rollout makes no commit. All the additions land as a single commit on
+`main`.
+
+## Inputs
+
+| Name | Required | Default | Description |
+|---|---|---|---|
+| `additions` | yes | | JSON array of `{"repo": …, "branch": …, "sourceBranch": …}`. `sourceBranch` defaults to `main` |
+| `commit-message` | no | `Update projects.json: register N new branch(es)` | Commit message |
+| `dry-run` | no | `false` | Write the file and capture the patch, commit and push nothing |
+| `token` | yes | | Token with `contents: write` on `spring-cloud-github-actions` |
+
+## Outputs
+
+| Name | Description |
+|---|---|
+| `changed` | `true` when `projects.json` was modified |
+| `patch` | The diff of the staged change, empty when nothing changed |
+
+## Example
+
+```yaml
+- uses: ./.github/actions/add-branches-projects-json
+  with:
+    additions: >-
+      [{"repo":"spring-cloud/spring-cloud-config","branch":"5.0.x","sourceBranch":"main"}]
+    token: ${{ secrets.GH_ACTIONS_REPO_TOKEN }}
+```
+
+Used by [`setup-next-release-train.yml`](../../workflows/README-setup-next-release-train.md).
+
+## Development
+
+```bash
+npm ci
+npm test
+npm run build   # rebuilds dist/index.js — verify-dist.yml fails if it is not committed
+```

.github/actions/add-branches-projects-json/__tests__/index.test.js

@@ -0,0 +1,149 @@
+'use strict';
+
+jest.mock('@actions/core');
+jest.mock('@actions/exec');
+
+const core = require('@actions/core');
+const { dumpsPretty, resolveJdkVersions, addBranch, addBranches } = require('../src/index');
+
+beforeEach(() => {
+  jest.clearAllMocks();
+  core.info.mockImplementation(() => {});
+  core.warning.mockImplementation(() => {});
+  core.error.mockImplementation(() => {});
+  core.setFailed.mockImplementation(() => {});
+  core.setSecret.mockImplementation(() => {});
+});
+
+function makeData() {
+  return {
+    defaults: {
+      oss: {
+        branches: { default: ['main'], scheduled: ['main'] },
+        jdkVersions: { main: ['17', '21', '25'], default: ['17', '21', '25'] },
+      },
+      commercial: {
+        branches: { default: ['4.3.x'], scheduled: ['4.3.x'] },
+        jdkVersions: { '4.3.x': ['17', '21', '25'], default: ['17', '21'] },
+      },
+    },
+    'spring-cloud-config': {
+      oss: {
+        branches: { default: ['main'], scheduled: ['main'] },
+        jdkVersions: { main: ['17', '21', '25'] },
+      },
+      commercial: {
+        branches: { default: ['3.3.x'], scheduled: ['3.3.x'] },
+        jdkVersions: { '3.3.x': ['17', '21'] },
+      },
+    },
+  };
+}
+
+// ── dumpsPretty ─────────────────────────────────────────────────────────────
+
+describe('dumpsPretty', () => {
+  test('keeps string arrays on a single line', () => {
+    expect(dumpsPretty({ scheduled: ['5.0.x', 'main'] })).toContain('["5.0.x", "main"]');
+  });
+});
+
+// ── addBranch ───────────────────────────────────────────────────────────────
+
+describe('addBranch', () => {
+  test('adds the branch to oss scheduled and copies the source branch JDKs', () => {
+    const data = makeData();
+    const changes = addBranch(data, 'spring-cloud/spring-cloud-config', '5.0.x', 'main');
+
+    expect(changes).toHaveLength(2);
+    expect(data['spring-cloud-config'].oss.branches.scheduled).toEqual(['5.0.x', 'main']);
+    expect(data['spring-cloud-config'].oss.jdkVersions['5.0.x']).toEqual(['17', '21', '25']);
+  });
+
+  test('leaves branches.default alone — main stays the default line', () => {
+    const data = makeData();
+    addBranch(data, 'spring-cloud/spring-cloud-config', '5.0.x', 'main');
+    expect(data['spring-cloud-config'].oss.branches.default).toEqual(['main']);
+  });
+
+  test('copies the JDK list rather than aliasing the source branch entry', () => {
+    const data = makeData();
+    addBranch(data, 'spring-cloud/spring-cloud-config', '5.0.x', 'main');
+    data['spring-cloud-config'].oss.jdkVersions['5.0.x'].push('26');
+    expect(data['spring-cloud-config'].oss.jdkVersions.main).toEqual(['17', '21', '25']);
+  });
+
+  test('modifies the commercial section for a -commercial repo', () => {
+    const data = makeData();
+    addBranch(data, 'spring-cloud/spring-cloud-config-commercial', '5.0.x', '3.3.x');
+    expect(data['spring-cloud-config'].commercial.branches.scheduled).toEqual(['5.0.x', '3.3.x']);
+    expect(data['spring-cloud-config'].commercial.jdkVersions['5.0.x']).toEqual(['17', '21']);
+    expect(data['spring-cloud-config'].oss.branches.scheduled).toEqual(['main']);
+  });
+
+  test('is idempotent — a second call reports no changes', () => {
+    const data = makeData();
+    addBranch(data, 'spring-cloud/spring-cloud-config', '5.0.x', 'main');
+    const changes = addBranch(data, 'spring-cloud/spring-cloud-config', '5.0.x', 'main');
+    expect(changes).toEqual([]);
+    expect(data['spring-cloud-config'].oss.branches.scheduled).toEqual(['5.0.x', 'main']);
+  });
+
+  test('seeds a missing project entry from defaults without mutating defaults', () => {
+    const data = makeData();
+    const changes = addBranch(data, 'spring-cloud/spring-cloud-new-thing', '5.0.x', 'main');
+
+    expect(changes[0]).toContain('seeded from defaults.oss');
+    expect(data['spring-cloud-new-thing'].oss.branches.scheduled).toEqual(['5.0.x', 'main']);
+    expect(data['spring-cloud-new-thing'].oss.jdkVersions['5.0.x']).toEqual(['17', '21', '25']);
+    // The shared defaults entry must come back untouched.
+    expect(data.defaults.oss.branches.scheduled).toEqual(['main']);
+    expect(data.defaults.oss.jdkVersions['5.0.x']).toBeUndefined();
+  });
+});
+
+// ── resolveJdkVersions ──────────────────────────────────────────────────────
+
+describe('resolveJdkVersions', () => {
+  test('falls back to the section default when the source branch has no entry', () => {
+    const data = makeData();
+    const sec = { jdkVersions: { default: ['21'] } };
+    expect(resolveJdkVersions(data, 'oss', sec, 'main')).toEqual(['21']);
+  });
+
+  test('falls back to the global defaults entry when the section has nothing', () => {
+    const data = makeData();
+    expect(resolveJdkVersions(data, 'oss', { jdkVersions: {} }, 'main')).toEqual(['17', '21', '25']);
+  });
+
+  test('falls back to 17/21 when projects.json has no defaults at all', () => {
+    expect(resolveJdkVersions({}, 'oss', {}, 'main')).toEqual(['17', '21']);
+  });
+});
+
+// ── addBranches ─────────────────────────────────────────────────────────────
+
+describe('addBranches', () => {
+  test('applies every addition and returns one description per change', () => {
+    const data = makeData();
+    const changes = addBranches(data, [
+      { repo: 'spring-cloud/spring-cloud-config', branch: '5.0.x', sourceBranch: 'main' },
+      { repo: 'spring-cloud/spring-cloud-commons', branch: '5.0.x' },
+    ]);
+
+    expect(changes.filter((c) => c.startsWith('spring-cloud/spring-cloud-config:'))).toHaveLength(2);
+    expect(data['spring-cloud-config'].oss.branches.scheduled).toContain('5.0.x');
+    expect(data['spring-cloud-commons'].oss.branches.scheduled).toContain('5.0.x');
+  });
+
+  test('defaults sourceBranch to main', () => {
+    const data = makeData();
+    addBranches(data, [{ repo: 'spring-cloud/spring-cloud-config', branch: '5.0.x' }]);
+    expect(data['spring-cloud-config'].oss.jdkVersions['5.0.x']).toEqual(['17', '21', '25']);
+  });
+
+  test('throws when an addition is missing a branch', () => {
+    expect(() => addBranches(makeData(), [{ repo: 'spring-cloud/spring-cloud-config' }]))
+      .toThrow(/needs a 'repo' and a 'branch'/);
+  });
+});

.github/actions/add-branches-projects-json/action.yml

@@ -0,0 +1,40 @@
+name: 'Add Branches to Projects JSON'
+description: >
+  Registers newly created release line branches in config/projects.json. Takes the whole
+  set of branches for a release train at once so the entire rollout lands as a single
+  commit instead of ~30 racing pushes.
+author: 'Spring Cloud Team'
+
+inputs:
+  additions:
+    description: >
+      JSON array of branches to register, e.g.
+      [{"repo":"spring-cloud/spring-cloud-config","branch":"5.0.x","sourceBranch":"main"}].
+      sourceBranch is the branch the new branch was cut from and is used to copy jdkVersions;
+      it defaults to "main".
+    required: true
+  commit-message:
+    description: 'Commit message for the projects.json commit'
+    required: false
+    default: ''
+  dry-run:
+    description: 'When true the file is written and the patch is captured, but nothing is committed or pushed'
+    required: false
+    default: 'false'
+  token:
+    description: 'GitHub token with contents:write on the spring-cloud-github-actions repository'
+    required: true
+
+outputs:
+  changed:
+    description: 'true when projects.json was modified'
+  patch:
+    description: 'The diff of the staged projects.json change, empty when nothing changed'
+
+runs:
+  using: node20
+  main: dist/index.js
+
+branding:
+  icon: 'file-text'
+  color: 'blue'