12:57:03 RRSAgent has joined #pub 12:57:03 logging to https://www.w3.org/2021/03/18-pub-irc 12:57:05 Zakim has joined #pub 12:58:18 sidvishnoi has joined #pub 12:59:13 dom has joined #pub 13:00:03 present+ plh 13:00:08 Present+ 13:00:11 wseltzer has joined #pub 13:00:13 present+ 13:00:14 present+ 13:00:19 cwilso has joined #pub 13:00:29 present+ 13:00:30 weiler has joined #pub 13:00:53 florian has joined #pub 13:01:10 present+ 13:01:18 xueyuan has joined #pub 13:01:18 Ralph has joined #pub 13:01:22 atsushi has joined #pub 13:01:25 present+ 13:01:25 present+ 13:01:42 present+ 13:02:08 xiaoqian has joined #pub 13:02:25 present+ 13:02:53 present+ 13:03:06 present+ 13:03:08 Bert has joined #pub 13:04:08 jeff has joined #pub 13:04:16 present+ 13:04:29 present+ 13:05:06 NOTE: the presentation is recorded 13:05:10 https://www.w3.org/2021/03/18-echidna/?full#1 13:05:13 scribe+ 13:05:32 Denis: main goal is help maintain /TR up-to-date 13:05:41 ... it should represent what the Web should be 13:05:51 [Slide 2] 13:06:03 Denis: in the past, the only way was to submit a request to the webmaster 13:06:12 ... outside of moratorium, etc. 13:06:17 Yves has joined #pub 13:06:22 ... this created delays, back-n-forth, etc. 13:06:43 caribou has joined #pub 13:06:44 ... given how heavy the Process, the specs were not published often, resulting in an outdated /TR 13:07:04 ... so we came with an automatic system 13:07:14 ... it checks if the resources can be downloaded 13:07:23 plh has changed the topic to: Slides: https://www.w3.org/2021/03/18-echidna/ (Recording in progress) 13:07:32 [Slide 3] 13:07:47 Denis: now the system has limitations, such as can't be used for FPWD 13:08:20 ... for CRs, limitation like if the doc changed WG 13:08:31 MikeSmith has joined #pub 13:08:42 ... Echidna can't handle shortname changes, some backward moves 13:08:46 [Slide 4] 13:09:21 Denis: you need your spec on GH. A group decision to use echidna. 13:09:35 ... need a token for each spec, generated by team contact/chair 13:09:42 ... should be kept private 13:09:57 ... you'll need admin rights to your GH repo 13:10:06 [Slide 5] 13:10:21 Denis: for CR snapshots, you'll need Director and Comm approval 13:10:34 ... w3c/transitions is used to get Director's approval 13:10:55 ... the template to raise a transition can be found in the README 13:11:04 ... when echidna will receive a request to publish 13:11:17 ... it will check the requirements 13:11:25 https://github.com/w3c/transitions/issues/199 13:11:26 https://github.com/w3c/transitions/issues/261 13:11:33 ... see examples linked from the slides 13:11:36 [Slide 6] 13:11:59 Denis: introduced how to setup the repo 13:12:18 ... Sid Vishnoi set up a GH action spec-prod to help 13:12:39 ... spec-prod can generate snapshots from respec/bikesheds 13:12:39 https://github.com/w3c/spec-prod/ 13:12:51 ... run checks like borken links 13:13:15 ... if the document is a compound one (like images, css, scripts), spec-prod will take care of them 13:13:32 [Slide 7] 13:13:45 Denis: first is to add the generated token 13:13:54 ... added as a repo secret 13:14:05 ... can be done in the settings of your repo 13:14:17 https://github.com/w3c/{REPO_NAME}/settings/secrets/actions 13:14:19 [Slide 8] 13:14:39 Denis: [shows screenshot of adding a token] 13:14:48 [Slide 9] 13:14:59 Denis: you're now ready to create the GH action workflow 13:15:06 ... it's a simple YAML file 13:15:22 ... [shows example] 13:16:04 ... here, the workflow runs on any pull requests and push on the main branch 13:17:13 ... with this workflow, spec-prod will generate snapshots of the source doc (index.html or index.bs by default) 13:17:31 ... if it's a push on the main, it will trigger echidna 13:17:37 [Slide 10] 13:17:49 Denis: parameters to customize the workflow 13:18:15 .... (going through the list of parameters) 13:18:42 ... if you want to receive an email after Echidna is done, use W3C_NOTIFICATIONS_CC 13:18:51 https://github.com/w3c/spec-prod/blob/main/docs/options.md 13:18:51 [Slide 11] 13:19:06 Denis: using those variables in YAML example 13:19:29 ... should read W#C_NOTIFICATIONS_CC on the slide 13:19:40 [Slide 12] 13:19:59 Denis: mainly focusing on /TR but spec-prod can be used for GH pages 13:20:12 [Slide 13] 13:20:19 Denis: checking the results from Echidna 13:20:28 ... the action tab will show you those 13:20:48 [Slide 14] 13:21:06 Denis: the screenshot sends a request to Echidna via a curl command 13:21:21 ... and then query for results 13:21:38 ... until the process returns for a result 13:21:45 https://lists.w3.org/Archives/Public/public-tr-notifications/ 13:21:56 marcosc has joined #pub 13:22:01 [Slide 15] 13:22:13 Denis: gives an overview on what is done and different steps 13:22:35 ... for a CR Snapshot, you'll need a transition request 13:23:31 ... [going through the workflow] 13:23:44 [Slide 16] 13:24:03 Denis: we presented spec-prod, which was built a few months ago 13:24:13 ... it's the easiest to get started 13:24:21 ... for alternatives, check the wiki 13:24:26 [Slide 17] 13:24:33 q? 13:24:36 q+ 13:24:37 Denis: if issues arise, get help 13:25:12 [Slide 18] 13:25:27 Denis: for the future, want to remove more limitations 13:25:41 ... some are related to the old process document 13:25:59 ... also look at facilitating revising W3C Recommendations 13:26:19 ... new things will get announced to spec-prod@w3.org 13:26:31 q+ to ask 13:26:48 ack florian 13:27:13 Florian: thank for Echidna. My workflow is different. we don't publish on every commit in CSS 13:27:20 Caroline_ has joined #pub 13:27:23 Present+ 13:27:29 [you could have a different branch where you only push WG-agreed changes] 13:27:32 ... substantive changes need to be explicitely approved for each publication 13:27:39 [and use spec-prod for pushes on that branch] 13:27:43 ... so the editor's draft hasn't been approved yet 13:27:53 ... so we use Echidna in a manual way 13:28:09 ... is there some intermediate way we could use? 13:28:20 qq+ 13:28:24 ... like flagging some drafts for publications but not others 13:28:49 ack dom 13:28:49 dom, you wanted to react to florian 13:29:15 xfq_ has joined #pub 13:29:23 Dom: simplest way would be a dedicated branch and you push on that branch. spec-prod would react only to that branch 13:29:45 Denis: an other event to listen is the one triggering the run manual 13:29:45 "workflow_dispatch" is another approach indeed 13:29:54 https://docs.github.com/en/actions/reference/events-that-trigger-workflows#workflow_dispatch 13:29:54 q? 13:30:17 Francois: workflow_dispatch works perfectly for that indeed 13:30:31 ack Mike 13:30:31 MikeSmith, you wanted to ask 13:30:43 Denis, that was a great presentation. Thank you very much! 13:31:12 Mike: sounds like an issue for spec-prod. other groups might have the same process than the CSS Process. 13:31:15 [documenting workflow_dispatch as an example in spec-prod sounds like a good addition indeed] 13:31:37 It's on roadmap: https://github.com/w3c/spec-prod/issues/6 13:31:43 .... so would benefit from builtin support 13:32:04 Mike: what about the case when somebody pushes more than once a day 13:32:32 ... I found that Echidna cannot republish to the same URL in /TR in multiple times on the same day 13:32:46 vivien has joined #pub 13:32:51 present+ 13:33:04 ... echidna checks for the same URL 13:33:09 ... and intentionally fails 13:33:14 [I thought echdina explicitly allowed several publications a day?] 13:33:37 https://github.com/w3c/spec-prod/pull/33#discussion_r595664294 13:33:55 Denis: Echidna should be able to publish multiple times on the same day. sounds like a bug 13:34:04 ... please report it 13:34:12 [it may be a bug in spec-prod too] 13:34:26 [I recall spec-prod has special handling for this] 13:34:51 Florian: the new one will replace the old one 13:35:10 Denis: indeed, the previous version should be the one published days before 13:35:34 Mike: that's the bug I'm running into 13:35:58 [there may be something about change of status shortnames (CR vs CRD vs WD)] 13:36:35 Denis: sounds like a spec-prod 13:36:55 Mike: but pubrules check those URLs 13:37:22 Florian: spec-prod fails to check if it's a same day pubrules 13:37:38 q? 13:38:07 Mike: but those links are generated from biblio 13:38:34 Dom: might a mis-configuration between bikeshed/spec-prod 13:39:04 q? 13:39:06 Denis: I'll follow up on this 13:39:28 [Relevant entry in Bikeshed doc: "Previous Version: from biblio" https://tabatkins.github.io/bikeshed/#metadata-previous-version ] 13:39:30 [you don't have to do that] 13:39:39 Mike: we shouldn't have to manually set the previous version 13:39:42 Denis: agreed 13:40:15 Denis: regarding different working group needs, I discussed with Sid about some WGs having different documents 13:40:28 https://github.com/w3c/spec-prod/pull/27 re previous version handling 13:40:31 In progress: https://github.com/w3c/spec-prod/issues/31 13:40:33 ... I believe Sid is monitoring the issue 13:40:55 ... so that's in the plan 13:41:01 q? 13:41:11 Florian: that would be nice indeed 13:41:27 [btw, SO MANY THANKS TO SID!!!] 13:41:30 q+ to ask about current status re link checker 13:41:36 ack tid 13:41:36 tidoust, you wanted to ask about current status re link checker 13:41:56 Francois: the linkchecker has been disabled in spec-prod 13:42:08 ... it's useful but prone to find false/positive 13:42:43 Sid: yes, it was generating too many false positive. looking into fixing some other issues next week as well 13:43:00 q? 13:43:04 Sid: it should work for a publication 13:43:19 https://www.npmjs.com/package/href-checker 13:43:24 Denis: the linkchecker is in GH 13:44:09 plh: why 2 linkcheckers? 13:44:22 Denis: the new one will check javascript links 13:44:23 I maintain the linkchecker on an irregular basis https://github.com/w3c/link-checker/ 13:45:07 Denis: Echidna doesn't check the links 13:45:24 ... I'm thinking about further integration of the new linkchecker 13:45:26 q+ to say thanks to Sid 13:45:31 ack Mike 13:45:31 MikeSmith, you wanted to say thanks to Sid 13:45:38 +1 13:45:41 +1 13:45:43 Mike: Thank you Sid 13:45:50 +1 13:45:51 +1 13:45:54 +1 13:45:55 ... this has been a massive timesaver 13:45:57 +1 13:46:06 ... for /TR and github.io URLs 13:46:30 MikeSmith++ 13:46:35 ... /me is looking forward to deploy spec-prod for pointerevents 13:46:37 sidvishnoi++ 13:46:40 sidvishnoi++ 13:46:47 Denis: thank you Sid 13:46:51 q? 13:46:54 q+ to wonder about additional files during publication to gh-pages 13:46:54 q+ 13:47:07 ack tid 13:47:07 tidoust, you wanted to wonder about additional files during publication to gh-pages 13:47:26 Francois: one clarification: publication in GH pages/branches 13:47:53 ... if there is a markdown document along, should I worry about them or will they get published 13:48:19 Sid: sped-prod is only for specifications, so unless it's embedded, it won't. Can look into it 13:48:36 Francois: ok, this means I need to manually add to the action 13:48:44 ack tidoust 13:49:23 ... the good thing with using GH pages, you end up with links not using the name of the branch 13:49:30 ... and GH translates from md to HTML for you 13:49:39 Sid: I'll add an option 13:49:44 ack florian 13:50:49 Florian: for transitions to CR or FPWD, can we redirect to a form to file the transition? 13:51:06 Denis: we'd thinking about improving the echidna report 13:51:18 ... since it's not always easy to understand it 13:51:28 ... we can point folks to the right direction 13:51:43 [anchoring the transition request flow into the publication request flow rather than the other way around] 13:53:38 denis++ 13:53:55 rrsagent, generate minutes v2 13:53:55 I have made the request to generate https://www.w3.org/2021/03/18-pub-minutes.html plh 13:54:36 rrsagent, make logs public-visible 13:55:50 caribou has left #pub 13:57:43 Yves has left #pub 15:57:42 Zakim has left #pub 15:58:36 RRSAgent, bye 15:58:36 I see no action items