Skip to content
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.

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

Revisit the release notes index. #3720

Open
ameukam opened this issue Aug 21, 2024 · 1 comment
Open

Revisit the release notes index. #3720

ameukam opened this issue Aug 21, 2024 · 1 comment
Labels
area/release-eng Issues or PRs related to the Release Engineering subproject kind/feature Categorizes issue or PR as related to a new feature. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. sig/release Categorizes an issue or PR as relevant to SIG Release.

Comments

@ameukam
Copy link
Member

ameukam commented Aug 21, 2024

We should stop use the GCS protocol for any URI part of the release notes index.

Currently:

curl -sSL https://dl.k8s.io/release/release-notes-index.json | jq '.' | grep '1.31'
  "v1.31.0": "gs://kubernetes-release/release/v1.31.0/release-notes.json",
  "v1.31.0-alpha.1": "gs://kubernetes-release/release/v1.31.0-alpha.1/release-notes.json",
  "v1.31.0-alpha.2": "gs://kubernetes-release/release/v1.31.0-alpha.2/release-notes.json",
  "v1.31.0-alpha.3": "gs://kubernetes-release/release/v1.31.0-alpha.3/release-notes.json",
  "v1.31.0-beta.0": "gs://kubernetes-release/release/v1.31.0-beta.0/release-notes.json",
  "v1.31.0-rc.0": "gs://kubernetes-release/release/v1.31.0-rc.0/release-notes.json",
  "v1.31.0-rc.1": "gs://kubernetes-release/release/v1.31.0-rc.1/release-notes.json"

Deprecation of gs://kubernetes-release (See kubernetes/k8s.io#2396) will likely prevent release notes to be consumed using the GCS protocol.

cc @kubernetes/release-engineering

/priority important-longterm

@ameukam ameukam added kind/feature Categorizes issue or PR as related to a new feature. sig/release Categorizes an issue or PR as relevant to SIG Release. area/release-eng Issues or PRs related to the Release Engineering subproject labels Aug 21, 2024
@k8s-ci-robot k8s-ci-robot added the priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. label Aug 21, 2024
@saschagrunert
Copy link
Member

saschagrunert commented Aug 28, 2024

@ameukam we can probably migrate the JSON to use the plain URL. Right now the release notes website does a conversion like this:

  /**
   * Get cdn.dl.k8s.io path from gs:// url in release index.
   *
   * @returns Transformed URL
   */
  private cdnLinkFromGsPath(path: string): string {
    const regex = /^gs:\/\/[\w-/.]*\.json$/;
    if (!path.match(regex)) {
      throw new Error(`Asset path from remote index "${path}" does not match regex ${regex}`);
    }
    return path.replace(/^gs:\/\/[\w-]*\//, 'https://cdn.dl.k8s.io/');
  }
}

Ref: https://github.com/kubernetes-sigs/release-notes/blob/a0cac340fd14e709cf5313f87106134b8d7f63e4/src/app/notes/notes.service.ts#L100-L112

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/release-eng Issues or PRs related to the Release Engineering subproject kind/feature Categorizes issue or PR as related to a new feature. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. sig/release Categorizes an issue or PR as relevant to SIG Release.
Projects
None yet
Development

No branches or pull requests

3 participants