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

Add version information to rendered output, alongside GitHub build context #107

Open
QuintinWillison opened this issue Oct 20, 2022 · 1 comment
Labels
build Relates to the tooling and/or scripts that render the HTML microsite published from here.

Comments

@QuintinWillison
Copy link
Contributor

QuintinWillison commented Oct 20, 2022

@SimonWoolf observes in #105 (review), relating to version number living in package.json, that:

It effectively annexes package.json to be part of the spec -- you're implementing an sdk and need to know what string to set x-ably-version to implement the spec, but to find that info you need to look in package.json.

Which also means it's no longer sufficient to look at https://sdk.ably.com/builds/ably/specification/main/features/ , because package.json isn't exposed there, you need to go to the git repo to get that info. That seems a bit messier to me.

In response to that observation I am creating this issue, which will hopefully explain better my vision for how that sort of information will be laid out clearly going forwards.

The plan is to display the version number on every HTML page rendered in the micro-site generated by the assemble workflow in this repository, alongside other salient GitHub build context (already done).

See also:

@sync-by-unito
Copy link

sync-by-unito bot commented Oct 20, 2022

➤ Automation for Jira commented:

The link to the corresponding Jira issue is https://ably.atlassian.net/browse/SDK-2859

@QuintinWillison QuintinWillison changed the title Add GitHub build context and version information to rendered output Add version information to rendered output, alongside GitHub build context Oct 21, 2022
@QuintinWillison QuintinWillison added the build Relates to the tooling and/or scripts that render the HTML microsite published from here. label Nov 1, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build Relates to the tooling and/or scripts that render the HTML microsite published from here.
Development

No branches or pull requests

1 participant