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

[docs] Add information on project administration #10832

Merged
merged 8 commits into from
Oct 2, 2018

Conversation

jugglinmike
Copy link
Contributor

@jugglinmike jugglinmike commented May 3, 2018

Document the various secrets and accounts necessary to administer
web-platform-tests and its related project.


This is a work-in-progress: some owners are clearly missing, and I suspect that I have overlooked other relevant accounts.

Document the various secrets and accounts necessary to administer
web-platform-tests and its related project.
order: -1
---

The web-platform-tests project is more than just tests! This section documents
Copy link
Contributor

Choose a reason for hiding this comment

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

Not sure this first sentencce is adding much.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Just a little levity. I'll remove it

## Third-party account owners

- (unknown registrar): https://web-platform-tests.org
- ???
Copy link
Contributor

Choose a reason for hiding this comment

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

I own that.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah, thanks. Mind sharing who you've registered it through?

[Let's Encrypt](https://letsencrypt.org/), so that data does not represent an
explicitly-managed secret.

## Third-party account owners
Copy link
Contributor

Choose a reason for hiding this comment

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

Sauce?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@zcorpan asked the same thing. Tho account we use for the results-collection are present in encrypted form in that repository, so they are available to anyone who has the "Password for app secrets" documented above. Because of this, and because re-using them in other contexts could cause interference, I think they should be considered an implementation detail of that project and omitted from this organization-wide document.

@jugglinmike
Copy link
Contributor Author

@jgraham I'm curious if you have thoughts about the two sections present in this draft. I wouldn't consider Sauce Labs credentials to be appropriate for the "Third-party account owners" section because they are a secret shared by many individuals. I made that section for other privileges that may be granted to or revoked from each person. Does that make sense? Would it be more clear if the section were titled "Third-party account members" instead?

[results-collection] | Password for app secrets | boaz@bocoup.com, mike@bocoup.com, rick@bocoup.com
[pull-requests-dashboard] | root SSH keys | ???
[pull-requests-dashboard] | Password for app secrets | boaz@bocoup.com, geoffers@gmail.com, jgraham@hoppipolla.co.uk, lukebjerring@google.com, mike@w3.org
[web-platform-tests] | TravisCI authorization | ???
Copy link
Member

Choose a reason for hiding this comment

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

Travis CI authorisation for what?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm not sure, exactly. The project's .travis.yml file currently includes three encrypted values. Two seem to authorize uploading of generated test manifest files. The third is used by the "stability checker" job; I don't know what pridileged action that needs to take.

Copy link
Member

Choose a reason for hiding this comment

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

The test manifest stuff just runs off of @jgraham's account; I think they're just personal access tokens so could be replaced by anyone's?

Don't know what the stability checker job has the secure env variables for; maybe the PR dashboard?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good question. I did some digging, and it looks like they're no longer necessary: #10937 . That, together with the fact that manifest upload credentials are synonymous with organization membership, means that this entry can be removed. Thanks!

- ???
- (unknown registrar): https://w3c-test.org
- ???
- (unknown registrar): http://testthewebforward.org
Copy link
Member

Choose a reason for hiding this comment

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

W3C Systeam.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

For this initial effort, I'd like to end up with a document that definitively identifies points-of-contact for each bit of secret information. Does the team have a shared e-mail address? Or could you tell me where I could find its member list?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

From https://www.w3.org/blog/systeam/, this appears to be web-human@w3.org . Does that sound right to you?

Copy link
Contributor

Choose a reason for hiding this comment

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

+- (unknown registrar): https://w3c-test.org
+  - ???
+- (unknown registrar): http://testthewebforward.org

From https://www.w3.org/blog/systeam/, this appears to be web-human@w3.org . Does that sound right to you?

Yes

@jugglinmike
Copy link
Contributor Author

We recently disabled the WPT Pull Requests Results Dashboard, so I've removed that from this document. If/when we re-enable it, the patch can introduce the relevant information.

As far as I know, that just leaves https://w3c-test.org. WHOIS indicates that this is owned by the W3C which is no surprise, but for this document, I'd like to have a real person. @gsnedders @plehegar do either of you know who I could add here?

- [@youennf](https://github.com/youennf)
- [@zcorpan](https://github.com/zcorpan)
- [GitHub](https://github.com): w3c
- ??? (soon to be obviated)
Copy link
Member

Choose a reason for hiding this comment

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

should be web-human@w3.org as well. Folks are always welcome to reach out to me and/or @sideshowbarker in any case.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks, Philippe! I'm preferring references to real people when possible because this is the first step in a larger effort to manage all these accounts.

@@ -57,6 +58,14 @@ explicitly-managed secret.
- boaz@bocoup.com
- mike@bocoup.com
- rick@bocoup.com
- E-mail address: wpt.pr.bot@gmail.com
- zcorpan@bocoup.com
Copy link
Member

Choose a reason for hiding this comment

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

Should be simon@

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Whoops. Fixed

- boaz@bocoup.com
- mike@bocoup.com
- [Heroku](https://heroku.com): wpt.pr.bot@gmail.com
- zcorpan@bocoup.com
Copy link
Member

Choose a reason for hiding this comment

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

and here

@jugglinmike
Copy link
Contributor Author

The document now includes contacts for all the accounts and secrets of which I am aware.

@wpt-pr-bot
Copy link
Collaborator

There are no owners for this pull request. Please reach out on W3C's irc server (irc.w3.org, port 6665) on channel #testing (web client) to get help with this. Thank you!

@jgraham jgraham merged commit d242e14 into web-platform-tests:master Oct 2, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants