Skip to content

fix(ci): preserve release source in Maven provenance #951

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jbeckwith-oai merged 1 commit into from
Aug 28, 2026
Merged

fix(ci): preserve release source in Maven provenance #951

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .github/workflows/create-releases.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -366,6 +366,7 @@ jobs:
--arg repository_id "$GITHUB_REPOSITORY_ID" \
--arg repository_owner_id "$GITHUB_REPOSITORY_OWNER_ID" \
--arg runner_environment "$RUNNER_ENVIRONMENT" \
--arg workflow_sha "$GITHUB_SHA" \
--arg source_sha "$SOURCE_SHA" \
--arg release_tag "$RELEASE_TAG" \
--arg invocation_id \
Expand All @@ -389,6 +390,10 @@ jobs:
}
},
resolvedDependencies: [
{
uri: ("git+" + $repository + "@" + $workflow_ref),
digest: { gitCommit: $workflow_sha }
},
{
uri: ("git+" + $repository + "@refs/tags/" + $release_tag),
digest: { gitCommit: $source_sha }
Expand Down
24 changes: 18 additions & 6 deletions buildSrc/src/test/kotlin/com/openai/gradle/GradleCacheTrustPolicyTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -372,7 +372,7 @@ class GradleCacheTrustPolicyTest {
}

@Test
fun `retry provenance resolves the checked out historical tag not the newer workflow SHA`() {
fun `retry provenance records historical release source beside canonical workflow source`() {
val workflow = Path.of("../.github/workflows/create-releases.yml").readText()
val parsedWorkflow = parseWorkflow(workflow)
val preparation =
Expand Down Expand Up @@ -469,14 +469,23 @@ class GradleCacheTrustPolicyTest {
val workflowSource = external["workflow"] as Map<*, *>
assertEquals("refs/heads/main", workflowSource["ref"])
assertEquals(".github/workflows/create-releases.yml", workflowSource["path"])
val dependency = (definition["resolvedDependencies"] as List<*>).single() as Map<*, *>
val dependencies = definition["resolvedDependencies"] as List<*>
assertEquals(2, dependencies.size)
val workflowDependency = dependencies[0] as Map<*, *>
assertEquals(
"git+https://github.com/openai/openai-java@refs/heads/main",
workflowDependency["uri"],
)
val workflowDigest = workflowDependency["digest"] as Map<*, *>
assertEquals(workflowSha, workflowDigest["gitCommit"])
val releaseDependency = dependencies[1] as Map<*, *>
assertEquals(
"git+https://github.com/openai/openai-java@refs/tags/v1.2.3",
dependency["uri"],
releaseDependency["uri"],
)
val digest = dependency["digest"] as Map<*, *>
assertEquals(sourceSha, digest["gitCommit"])
assertTrue(digest["gitCommit"] != workflowSha)
val releaseDigest = releaseDependency["digest"] as Map<*, *>
assertEquals(sourceSha, releaseDigest["gitCommit"])
assertTrue(releaseDigest["gitCommit"] != workflowSha)
val details = predicate["runDetails"] as Map<*, *>
val builder = details["builder"] as Map<*, *>
assertEquals(
Expand Down Expand Up @@ -964,8 +973,11 @@ class GradleCacheTrustPolicyTest {
preparation.environment.getValue("SOURCE_SHA"),
)
assertContains(preparationScript, "\"\$SOURCE_SHA\" != \"\$(git rev-parse HEAD)\"")
assertContains(preparationScript, "--arg workflow_sha \"\$GITHUB_SHA\"")
assertContains(preparationScript, "--arg source_sha \"\$SOURCE_SHA\"")
assertContains(preparationScript, "--arg workflow_ref \"\$GITHUB_REF\"")
assertContains(preparationScript, "uri: (\"git+\" + \$repository + \"@\" + \$workflow_ref)")
assertContains(preparationScript, "digest: { gitCommit: \$workflow_sha }")
assertContains(
preparationScript,
"uri: (\"git+\" + \$repository + \"@refs/tags/\" + \$release_tag)",
Expand Down
Loading