-
Notifications
You must be signed in to change notification settings - Fork 192
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
Add placeholder API for swiftly releases #828
base: main
Are you sure you want to change the base?
Conversation
api/v1/swiftly.json
Outdated
@@ -0,0 +1,15 @@ | |||
{ | |||
"version": "0.3.0", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would we want to host more versions on here or would this always point to the latest?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In my current thinking, this would only ever have a single version of swiftly. I can't think of good reasons why someone should want to cherry-pick a particular version to install.
Have we checked this get copied over automatically or do they need page metadata adding so Jekyll knows what to do with them? |
@0xTim the Jekyll mechanism is entirely opaque to me. I'm assuming a plain json without any template information will be taken literally by the template engine, but I'm not sure about that. To use the template engine for swiftly, I'd need to understand where in that data model the swiftly metadata will be kept. Suggestions are certainly welcome from anyone who understands the system. |
We can do the same as
After you will want to create a dir
|
…swiftly_release.yml with the latest release
@0xTim @shahmishal thank you, I've refactored the changes as you've suggested. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM - I'll let @shahmishal take a look as well before merging
@swift-ci test |
@swift-ci please test |
Moving this to draft until swiftly tar.gz / pkg are available on download.swift.org |
Related to #841, depending on which one lands first, we'll want to update the other one. |
As pitched in the forum this is a preliminary API providing metadata about the currently available swiftly release. https://forums.swift.org/t/new-swift-org-api-endpoint-for-the-current-swiftly-release/74702
Motivation:
Swiftly itself has a self-update mechanism to help provide an easy path to keep in sync with the capability of the swift.org website, and to roll out new features and bug fixes. Since swift.org is the place where the official swiftly releases will be published then this API is updated whenever there is a new release. Since there has not yet been a swiftly release on swift.org and existing swiftly installations do not yet use this new API mechanism, there are no expected clients of this API yet. This is a preliminary step to prepare for a release of swiftly when that does happen.
Modifications:
Added a new /api/v1/swiftly.json endpoint with metadata about the current swiftly release, for now, until the next swiftly is released.
Result:
As a result, this endpoint will be accessible to swiftly when it is released.