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

CI: Create a CI job that builds the spec PDF and HTML for a PR #1301

Open
vlstill opened this issue Aug 14, 2024 · 4 comments
Open

CI: Create a CI job that builds the spec PDF and HTML for a PR #1301

vlstill opened this issue Aug 14, 2024 · 4 comments

Comments

@vlstill
Copy link
Contributor

vlstill commented Aug 14, 2024

... I think this would be very useful and it would make it easier to check small changes (where one can be quite certain to not break anything, but still wants to make sure) without having to bring up build locally.

The question is, should we do it soon (for Madoko) and then update it for AsciiDoc, or wait until we have migrated to AsciiDoc (#1298).

@jonathan-dilorenzo
Copy link
Collaborator

I'd probably propose waiting until AsciiDoc migration since it appears to be impending, but let's discuss in meeting.

I know that P4Runtime already has something like this, though I don't know anything about how it works. Just that I can go to https://s3-us-west-2.amazonaws.com/p4runtime/ci/main/P4Runtime-Spec.html (and replace main with any other branch) and it will render the specification.

@jnfoster
Copy link
Collaborator

jnfoster commented Sep 9, 2024

Um, we have this?

See for example here: https://p4.org/p4-spec/docs/p4-16-working-draft.html and look at the HTML source.

@jnfoster
Copy link
Collaborator

jnfoster commented Sep 9, 2024

Oh, sorry. I see. We only have this for main not for every PR. Sure.

@Dscano
Copy link

Dscano commented Oct 20, 2024

Hi everyone, I’ve prepared a draft version based on the approach used in the P4Runtime repo. Currently, I still need to resolve issues with creating the Docker container for the AsciiDoc environment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants