-
Notifications
You must be signed in to change notification settings - Fork 89
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
Publish spec for generic-table-dev branch in CI #436
Comments
Renaming the workflow to something more generic and adding the new branch as a trigger seems like a good idea to me. |
Thanks, Antonin, I can try that. Let's see if @jnfoster has anything to add. Add the workflow and updating the S3 link are separate things which can be in one PR or two. |
Sorry I wasn't clear. Note that the version stored in S3 and the version that would be stored in Github pages is the same. So one could argue that https://s3-us-west-2.amazonaws.com/p4runtime/ci/generic-table-dev/P4Runtime-Spec.html is sufficient. |
Here's what we did for the P4 language spec. The p4.org web server has these static pages:
<!DOCTYPE html>
<html>
<head>
<script>
const url = "https://raw.githubusercontent.com/p4lang/p4-spec/gh-pages/docs/P4-16-working-spec.html";
const req = new XMLHttpRequest();
req.open("GET", url, true);
req.onload = (_) => {
const doc = document.open("text/html", "replace");
doc.write( req.response );
doc.close();
};
req.send(null)
</script>
</head>
<body></body>
</html>
<!DOCTYPE html>
<html>
<head>
<script>
const url = "https://raw.githubusercontent.com/p4lang/p4-spec/gh-pages/docs/P4-16-working-spec.pdf";
const req = new XMLHttpRequest();
req.open("GET", url, true);
req.responseType = "arraybuffer";
req.onload = (_) => {
const blob = new Blob([new Uint8Array(req.response)], { type: "application/pdf" });
var newUrl = URL.createObjectURL(blob);
window.location.href = newUrl;
};
req.send(null);
</script>
</head>
<body>
</body>
</html> And there is a script that automatically builds these GitHub Pages-hosted versions on every commit to the As @antoninbas said, you could shift to GitHub Pages URLs, or just as well use the S3-hosted URLs... it should work either way. |
@jnfoster thanks, I'll look into this once we have a spec to publish! |
generic-table-dev branch will be a long-livid working branch with significant specification additions. To facilitate community participation and review, we should publish this version to GitHub pages along with
main
. We can do this a couple different ways:main
is specified in the job stepsOnce we get a spec published, we can put a link to it on the main README.
The text was updated successfully, but these errors were encountered: