Meta: add auto-deploy, and missing boilerplate

domenic · web-flow · commit b71846bdabb7 · 2019-07-31T11:17:20.000-04:00
Closes #36 by including that change.
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,15 @@
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+charset = utf-8
+indent_size = 2
+indent_style = space
+trim_trailing_whitespace = true
+
+[spec.bs]
+indent_size = 4
+
+[Makefile]
+indent_style = tab
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1,2 @@
+*    text=auto
+*.bs diff=html linguist-language=HTML
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,2 @@
+spec.html
+out/
diff --git a/.pr-preview b/.pr-preview
@@ -0,0 +1,4 @@
+{
+  "src_file": "spec.bs",
+  "type": "bikeshed"
+}
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,21 @@
+language: generic
+
+script:
+  - make ci
+
+branches:
+  only:
+    - master
+
+notifications:
+  email:
+    on_success: never
+    on_failure: always
+
+deploy:
+  provider: pages
+  local-dir: out
+  committer-from-gh: true
+  skip-cleanup: true
+  keep-history: true
+  github-token: $GH_TOKEN
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,3 @@
+# Code of Conduct
+
+All documentation, code, and communication under this repository are covered by the [W3C Code of Ethics and Professional Conduct](https://www.w3.org/Consortium/cepc/).
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,36 @@
+# Contribution Details
+
+## Joining WICG
+
+This repository is being used for work in the W3C [Web Platform Incubator Community Group](https://www.w3.org/community/wicg/) (WICG), governed by the [W3C Community License Agreement (CLA)](http://www.w3.org/community/about/agreements/cla/). To make substantive contributions, you must join the Community Group, thus signing the CLA.
+
+## Editing the specification
+
+Edits to the specification are done in the `spec.bs` file, which is then compiled with the [Bikeshed](https://tabatkins.github.io/bikeshed/) spec pre-processor.
+
+To build the specification, you can use one of:
+
+- `make local`: uses a locally-installed copy of Bikeshed
+- `make remote`: uses a Bikeshed web service, so you don't have to install anything locally
+
+## Tests
+
+Tests are maintained as part of the [web platform tests](https://github.com/web-platform-tests/wpt) project, under the [`lifecycle`](https://github.com/web-platform-tests/wpt/tree/master/lifecycle) directory.
+
+## For maintainers: identifying contributors to a pull request
+
+If the author is not the sole contributor to a pull request, please identify all contributors in the pull request comment.
+
+To add a contributor (other than the author, which is automatic), mark them one per line as follows:
+
+```
++@github_username
+```
+
+If you added a contributor by mistake, you can remove them in a comment with:
+
+```
+-@github_username
+```
+
+If the author is  making a pull request on behalf of someone else but they had no part in designing the feature, you can remove them with the above syntax.
diff --git a/LICENSE.md b/LICENSE.md
@@ -0,0 +1,3 @@
+All Reports in this Repository are licensed by Contributors under the [W3C Software and Document License](http://www.w3.org/Consortium/Legal/2015/copyright-software-and-document).
+
+Contributions to Specifications are made under the [W3C CLA](https://www.w3.org/community/about/agreements/cla/).
diff --git a/Makefile b/Makefile
@@ -1,5 +1,30 @@
+SHELL=/bin/bash
+
 local: spec.bs
-	bikeshed spec spec.bs spec.html
+	bikeshed --die-on=warning spec spec.bs spec.html
+
+spec.html: spec.bs
+	@ (HTTP_STATUS=$$(curl https://api.csswg.org/bikeshed/ \
+	                       --output spec.html \
+	                       --write-out "%{http_code}" \
+	                       --header "Accept: text/plain, text/html" \
+	                       -F die-on=warning \
+	                       -F file=@spec.bs) && \
+	[[ "$$HTTP_STATUS" -eq "200" ]]) || ( \
+		echo ""; cat spec.html; echo ""; \
+		rm -f spec.html; \
+		exit 22 \
+	);
+
+remote: spec.html
+
+ci: spec.bs
+	mkdir -p out
+	make remote
+	mv spec.html out/index.html
+	cp *.png out/
+	echo '<!DOCTYPE html><meta charset="utf-8"><title>Redirecting</title><meta http-equiv="refresh" content="0; URL=./"><link rel="canonical" href="./">' > out/spec.html
 
-remote: spec.bs
-	curl https://api.csswg.org/bikeshed/ -f -F file=@spec.bs > spec.html
+clean:
+	rm spec.html
+	rm -rf out
diff --git a/README.md b/README.md
@@ -1,5 +1,5 @@
 # Lifecycle API for Web Pages
-Link to spec: https://wicg.github.io/page-lifecycle/spec.html
+Link to spec: https://wicg.github.io/page-lifecycle/
 
 ## Motivation
 For detailed motivation see [this doc](https://docs.google.com/document/d/1UuS6ff4Fd4igZgL50LDS8MeROVrOfkN13RbiP2nTT9I/edit#heading=h.ejq0luje6eyb).
@@ -61,7 +61,7 @@ It is not possible to have a guaranteed callback execute in most of these scenar
 We following changes are included in the MVP:
 
 * `onfreeze` is fired to signal transition to FROZEN.
-* `onresume` is fired to signal transition out of FROZEN. This will be used to undo what was done in `onfreeze` above. 
+* `onresume` is fired to signal transition out of FROZEN. This will be used to undo what was done in `onfreeze` above.
 * On DISCARDED -> ACTIVE, an attribute called `wasDiscarded` is added to the Document. This will be used to restore view state , when the user revisits a discarded tab.
 * `onfreeze` is also fired before transition to BFCACHE (before `pagehide` is fired) and `onresume` is also fired on transition out of BFCACHE (after `pageshow` is fired).
 
@@ -81,7 +81,7 @@ The callbacks are necessary for several reasons:
 * Platform predictability and transparency in the face of freezing & discarding interventions becoming the norm. Specifically helping:
     * Analytics
     * Testing story
-    
+
 For details see [this section of detailed doc](https://docs.google.com/document/d/1UuS6ff4Fd4igZgL50LDS8MeROVrOfkN13RbiP2nTT9I/edit#heading=h.s64wegvpugn9).
 
 ### API
@@ -129,15 +129,15 @@ if (document.wasDiscarded) {
 #### Potential future addition
 In the future, if frame-level freezing (i.e. freeze specific frames within a page) is pursued, then the API could be enhanced to indicate which frame tree is frozen.
 ```
-// Indicate what is frozen exactly: 
+// Indicate what is frozen exactly:
 // a. partial frame tree starting with current frame
 // b. partial frame tree starting with an ancestor frame
 // c. entire page in background
 // d. ...
 enum FrameLevel { ... };
 
 interface FreezeEvent {
-    readonly attribute FrameLevel frameLevel; 
+    readonly attribute FrameLevel frameLevel;
 }
 ```
 
diff --git a/spec.bs b/spec.bs
@@ -1,11 +1,10 @@
 <pre class='metadata'>
 Title: Page Lifecycle
-Group: webperf
+Group: WICG
+Status: CG-DRAFT
 Shortname: page-lifecycle
 Level: 1
-ED:
-TR:
-Status: ED
+URL: https://wicg.github.io/page-lifecycle/
 Editor: Shubhie Panicker, Google https://google.com, panicker@google.com
 Editor: Domenic Denicola, Google https://google.com, d@domenic.me
 Repository: wicg/page-lifecycle
@@ -265,8 +264,8 @@ Specific examples:
 
     NOTE: background tabs that are actively doing work on behalf of the user (eg. playing audio) are generally not [=/frozen=] or [=/discarded=].
 
-    NOTE: For a detailed list of heuristics & exclusions used by Chrome, see <a href=https://docs.google.com/document/d/1QJpuBTdllLVflMJSov0tlFX3e3yfSfd_-al2IBavbQM/edit>this doc</a>. 
-    
+    NOTE: For a detailed list of heuristics & exclusions used by Chrome, see <a href=https://docs.google.com/document/d/1QJpuBTdllLVflMJSov0tlFX3e3yfSfd_-al2IBavbQM/edit>this doc</a>.
+
 The UA will typically execute [=change the frozenness of a top-level document=] with false when the user revisits that browsing context. In addition, the UA may choose to periodically execute [=change the frozenness of a top-level document=] with false in the background, if plentiful resources are available.
 
 <h4 id="changing-frozenness">Changing the frozenness of documents</h4>
@@ -332,7 +331,7 @@ Browsing contexts -- that are in the background and have their documents in <a h
 
     NOTE: background tabs that are actively doing work on behalf of the user (eg. playing audio) are generally not [=/discarded=].
 
-    NOTE: For a detailed list of heuristics & exclusions used by Chrome, see <a href=https://docs.google.com/document/d/1QJpuBTdllLVflMJSov0tlFX3e3yfSfd_-al2IBavbQM/edit>this doc</a>. 
+    NOTE: For a detailed list of heuristics & exclusions used by Chrome, see <a href=https://docs.google.com/document/d/1QJpuBTdllLVflMJSov0tlFX3e3yfSfd_-al2IBavbQM/edit>this doc</a>.
 
 When a [=top-level browsing context=] (tab in the browser) is [=/discarded=] due to resource pressure (or unexpected events eg. process crash), and later the user revisits the tab in the browser, then the {{Document}}'s [=Document/discarded=] boolean will be true due to [[#html-initialize-doc]].
 
diff --git a/spec.html b/spec.html
diff --git a/w3c.json b/w3c.json

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+* text=auto`
	`2`	`+*.bs diff=html linguist-language=HTML`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +{
 +  "src_file": "spec.bs",
 +  "type": "bikeshed"
 +}
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# Code of Conduct`
	`2`	`+`
	`3`	`+All documentation, code, and communication under this repository are covered by the [W3C Code of Ethics and Professional Conduct](https://www.w3.org/Consortium/cepc/).`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+All Reports in this Repository are licensed by Contributors under the [W3C Software and Document License](http://www.w3.org/Consortium/Legal/2015/copyright-software-and-document).`
	`2`	`+`
	`3`	`+Contributions to Specifications are made under the [W3C CLA](https://www.w3.org/community/about/agreements/cla/).`