Swift.org install api to support installer tools (Swiftly)

[shahmishal]

Swift.org install api to support installer tools (Swiftly)

To support Swiftly, I propose static JSON API endpoints from YAML files that will be created during the Jekyll build phase. These endpoints will allow users to access a list of releases at swift.org/api/v1/install/releases.json, containing information about tags, platforms, architectures, and docker tags. The dev endpoint, swift.org/api/v1/install/dev/<branch>/<platform>.json, will provide a list of development toolchain information. In the future, we should provide REST APIs which can be dynamic and supports query parameters.

├── api
│   └── v1
│       └── install
│           ├── dev
│           │   ├── 6.0
│           │   │   ├── amazonlinux2.json
│           │   │   ├── centos7.json
│           │   │   ├── macos.json
│           │   │   ├── static-sdk.json
│           │   │   ├── ubi9.json
│           │   │   ├── ubuntu2004.json
│           │   │   ├── ubuntu2204.json
│           │   │   └── windows10.json
│           │   └── main
│           │       ├── amazonlinux2.json
│           │       ├── centos7.json
│           │       ├── macos.json
│           │       ├── static-sdk.json
│           │       ├── ubi9.json
│           │       ├── ubuntu2004.json
│           │       ├── ubuntu2204.json
│           │       └── windows10.json
│           └── releases.json

[alexandersandberg]

It would be amazing if we could use e.g. https://github.com/avillafiorita/jekyll-datapage_gen (do we even need a plugin? I'm no Jekyll expert) to dynamically generate these endpoints based on a single source of truth data file—I guess _data/builds/swift_releases.yml would be enough?

This data file could then also be used to generate the pages for /install, instead of manually creating them as well as their content for each new supported platform/version, since this can easily lead to inconsistencies.

[shahmishal]

In this pull request, the data are generated from the yml file during the build phase so it would signal source of truth.

for example, its reading the value from the _data and converting it to json.

{{ site.data.builds.swift-6_0-branch.amazonlinux2-aarch64 | jsonify}}

[alexandersandberg]

In this pull request, the data are generated from the yml file during the build phase so it would signal source of truth.

for example, its reading the value from the _data and converting it to json.

{{ site.data.builds.swift-6_0-branch.amazonlinux2-aarch64 | jsonify}}

I mean to generate the "template" endpoint files for each version as well, so we don't have to create a new api/v1/install/dev/6.0/{platform/version}.json JSON file when we add support for more platforms/versions.

I guess now we would also have to duplicate the platform/version JSON files for each new Swift version as well. If they were generated, adding support for a future Swift version would be as simple as only updating the source of truth data file.

[shahmishal]

I will look into https://github.com/avillafiorita/jekyll-datapage_gen plugin, I noticed the repo has not been updated for 2 years (it might be fine).

[kaishin]

This works well enough for the time being, even though I agree with @alexandersandberg that we can benefit from generating the JSON files dynamically.

[0xTim]

Looks like a great step in the right direction! Do appear to be missing the newer platforms though

[shahmishal]

Looks like a great step in the right direction! Do appear to be missing the newer platforms though

The new platforms are available part of the releases.json only because nightly toolchains currently have an issue with new platforms on main and release/6.0 branches.

[shahmishal]

@swift-ci test

[kkebo]

When do you plan to add dev/6.1 to swift.org install API?