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 WHATWG Commit Snapshot computed metadata #1635

Merged
merged 10 commits into from
Apr 6, 2020
Merged

Conversation

annevk
Copy link
Collaborator

@annevk annevk commented Mar 27, 2020

@tabatkins api.csswg.org picks this up immediately, right? We need to change our invocation of that and I wonder how we need to balance things.

cc @domenic

annevk added a commit to whatwg/whatwg.org that referenced this pull request Mar 27, 2020
They will now use a title aligned with Review Drafts, use the snapshot logo, and generally include less data that is best looked for in the Living Standard.

Depends upon speced/bikeshed#1635.

Closes whatwg/meta#88. Closes #309.
Copy link
Collaborator

@domenic domenic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This could go further, updating computed-metadata.include to replace [SNAPSHOT-LINK] with a line that uses [COMMIT-SHA]. Then we could remove all the lines in the deploy script that deal with SNAPSHOT-LINK.

Finally we could also move the warning stuff here by adding a header-LS-COMMIT, similar to what we did for header-RD.

@annevk
Copy link
Collaborator Author

annevk commented Mar 27, 2020

Duplicating the whole header to remove the need for md-warning="Commit $SHA $COMMIT_URL_BASE$SHA replaced by $LS_URL" seems like the wrong direction to me.

@domenic
Copy link
Collaborator

domenic commented Mar 27, 2020

Hmm. I like the way it keeps things centralized, but I see what you mean. There's probably also a way of avoiding the duplication, but I can try to make that work on top of this.

@domenic
Copy link
Collaborator

domenic commented Mar 27, 2020

OK, I:

  • Added back the links that I prefer to keep, since in IRC @annevk said he'd be OK with that
  • Inlined the logo instead of keeping it in a separate file; this removes a wrapper <p>. This has nothing to do with the rest of the PR and is just something that has been bugging me slightly. I'm happy to remove it from this PR.
  • Managed to get automatic warnings generated into the right place using the COMMIT-SHA. Improve Commit Snapshot setup whatwg/whatwg.org#310 is updated to take this into account. It stops using the "commit" warning type in favor of the "obsolete" warning type, because the commit warning type wants specific inputs, whereas with the "obsolete" warning type we can just use the COMMIT-SHA input alone. This feels kind of like a hack but also kind of elegant.

We should probably not merge this until all three of us are online and can sync the whatwg.org PR and discuss whether it's the best strategy. But, I'm pretty happy with it.

Copy link
Collaborator Author

@annevk annevk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I cannot approve this, but I'm happy with it.

@annevk
Copy link
Collaborator Author

annevk commented Apr 2, 2020

@domenic I checked with Tab and I can land this once we know what we want .pr-preview.json to look like. I also rebased the tests so CI will continue to pass.

domenic added a commit to whatwg/spec-factory that referenced this pull request Apr 3, 2020
@domenic
Copy link
Collaborator

domenic commented Apr 3, 2020

OK, this is ready. It adds a new status, LS-PR, specifically for PR previews. This allows us to get a dedicated warning and h1 that talk about the PR, for example.

@annevk
Copy link
Collaborator Author

annevk commented Apr 6, 2020

Update WHATWG metadata

To better account for Commit Snapshots and PR Preview.

See also https://github.com/whatwg/whatwg.org/pull/310 and https://github.com/whatwg/spec-factory/pull/5.

@annevk annevk merged commit 3d0743c into master Apr 6, 2020
@annevk annevk deleted the annevk/whatwg-cs-metadata branch April 6, 2020 14:15
annevk added a commit to whatwg/whatwg.org that referenced this pull request Apr 6, 2020
Buids upon speced/bikeshed#1635. Remaining work tracked by whatwg/spec-factory#5.

Closes whatwg/meta#88. Closes #309.

Co-authored-by: Domenic Denicola <d@domenic.me>
annevk pushed a commit to whatwg/spec-factory that referenced this pull request Apr 6, 2020
domenic added a commit to whatwg/spec-factory that referenced this pull request Apr 13, 2020
The recent changes in speced/bikeshed#1635 also need to be reflected into the spec Makefiles.
annevk pushed a commit to whatwg/spec-factory that referenced this pull request Apr 23, 2020
The recent changes in speced/bikeshed#1635 also need to be reflected into the spec Makefiles.
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

Successfully merging this pull request may close these issues.

None yet

2 participants