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

[Monorepo] Netlify to replace pr-review #2242

Open
2 of 4 tasks
spectranaut opened this issue Jun 13, 2024 · 3 comments
Open
2 of 4 tasks

[Monorepo] Netlify to replace pr-review #2242

spectranaut opened this issue Jun 13, 2024 · 3 comments
Labels
Agenda-Editors editorial a change to an example, note, spelling, grammar, or is related to publishing or the repo

Comments

@spectranaut
Copy link
Contributor

spectranaut commented Jun 13, 2024

We also want to look to add the follow features to our netlify publications:

  • links in the comment from netlify to all specs that were edited by the PR, like: https://deploy-preview-2284--wai-aria.netlify.app/core-aam/
  • Can we have some kind of banner/message -- that links from the netlify publication back to the PR it was generated from? Explains what this is a preview of?
  • Eventually, we will need successful links between specs generated by the PR instead of links to the editor's drafts
  • publish generated respec document (instead of running respec client side)
@spectranaut spectranaut added the editorial a change to an example, note, spelling, grammar, or is related to publishing or the repo label Jun 13, 2024
@daniel-montalvo daniel-montalvo changed the title Netlify to replace pr-review [Monorepo] Netlify to replace pr-review Jul 8, 2024
@daniel-montalvo
Copy link
Contributor

daniel-montalvo commented Jul 8, 2024

We now have statically-generated PR previews
#2265
All pages changed can be viewed from within the "Checks" tab, for example in https://github.com/w3c/aria/pull/2284/checks/> Netlify > Page changed

@spectranaut
Copy link
Contributor Author

About Eventually, we will need successful links between specs generated by the PR instead of links to the editor's drafts -- If, for core-aam, we add the ED links like this:

  ariaSpecURLs: {
    ED: "../index.html",
    CR: "https://w3c.github.io/aria/",
    CRD: "https://w3c.github.io/aria/",
    PR: "https://www.w3.org/TR/wai-aria/",
    REC: "https://www.w3.org/TR/wai-aria/",
  },
  accNameURLs: {
    ED: "../accname/index.html",
    CR: "https://w3c.github.io/accname/",
    CRD: "https://w3c.github.io/accname/",
    PR: "https://www.w3.org/TR/accname-1.2/",
    REC: "https://www.w3.org/TR/accname-1.2/",
  },

It works in PR preview, which you could see before I realized w3c.github.io/core-aam editor draft would be broken: #2298

So maybe we really do need to set up all the w3c.github.io/* to directed back to this repository. Then if we do this for all the specs, the links will be correct in PR preview... right...?

@daniel-montalvo
Copy link
Contributor

@spectranaut @pkra @jnurthen and all.

I have followed an approach similar to @spectranaut comments above in https://github.com/daniel-montalvo/aria

The build process now has a bash script that replaces specStatus with "unofficial" and then includes the unofficial keys for the resolveReferences function to generate relative links in the PRs.

For a prototype of how this could work, see
https://staging-aria.netlify.app
and add / to get to the other specs as desired.

I am using the Netlify production context for now because this is just a test. If we are happy with this approach, I will adjust the main ARIA netlify configuration file accordingly so that this only runs in PRs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Agenda-Editors editorial a change to an example, note, spelling, grammar, or is related to publishing or the repo
Projects
None yet
Development

No branches or pull requests

3 participants