From 8b46ca5bf4b51a25f1c147d196d8e78cfab2f01d Mon Sep 17 00:00:00 2001
From: Yoann Chaudet <yoannchaudet@github.com>
Date: Wed, 13 Jul 2022 11:47:37 -0700
Subject: [PATCH] Document artifacts validation + reformat a few things

---
 .github/CODEOWNERS          |  3 ++-
 .github/release-drafter.yml | 44 ++++++++++++++++++-------------------
 README.md                   | 20 +++++++++++++++--
 action.yml                  | 12 +++++-----
 4 files changed, 48 insertions(+), 31 deletions(-)

diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
index ad7a823..cc1fef2 100644
--- a/.github/CODEOWNERS
+++ b/.github/CODEOWNERS
@@ -1 +1,2 @@
-* @paper-spa/pages
\ No newline at end of file
+# Default PR reviewers
+* @actions/pages
diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml
index fa94980..2735ea1 100644
--- a/.github/release-drafter.yml
+++ b/.github/release-drafter.yml
@@ -1,6 +1,6 @@
 ---
-name-template: 'v$RESOLVED_VERSION'
-tag-template: 'v$RESOLVED_VERSION'
+name-template: "v$RESOLVED_VERSION"
+tag-template: "v$RESOLVED_VERSION"
 template: |
   # Changelog
 
@@ -8,33 +8,33 @@ template: |
 
   See details of [all code changes](https://github.com/$OWNER/$REPOSITORY/compare/$PREVIOUS_TAG...v$RESOLVED_VERSION) since previous release.
 categories:
-  - title: '🚀 Features'
+  - title: "🚀 Features"
     labels:
-      - 'feature'
-      - 'enhancement'
-  - title: '🐛 Bug Fixes'
+      - "feature"
+      - "enhancement"
+  - title: "🐛 Bug Fixes"
     labels:
-      - 'fix'
-      - 'bugfix'
-      - 'bug'
-  - title: '🧰 Maintenance'
+      - "fix"
+      - "bugfix"
+      - "bug"
+  - title: "🧰 Maintenance"
     labels:
-      - 'infrastructure'
-      - 'automation'
-      - 'documentation'
-  - title: '🏎 Performance'
-    label: 'performance'
-change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
+      - "infrastructure"
+      - "automation"
+      - "documentation"
+  - title: "🏎 Performance"
+    label: "performance"
+change-template: "- $TITLE @$AUTHOR (#$NUMBER)"
 version-resolver:
   major:
     labels:
-      - 'type: breaking'
+      - "type: breaking"
   minor:
     labels:
-      - 'type: enhancement'
+      - "type: enhancement"
   patch:
     labels:
-      - 'type: bug'
-      - 'type: maintenance'
-      - 'type: documentation'
-  default: patch
\ No newline at end of file
+      - "type: bug"
+      - "type: maintenance"
+      - "type: documentation"
+  default: patch
diff --git a/README.md b/README.md
index cfa656a..b2659a7 100644
--- a/README.md
+++ b/README.md
@@ -4,7 +4,7 @@ A composite action for packaging and uploading artifact that can be deployed to
 
 # Scope
 
-⚠️ Official support for building Pages with Actions is in public beta at the moment. The scope is currently limited to **public repositories only**.
+⚠️ Official support for building Pages with Actions is in public beta at the moment.
 
 # Usage
 
@@ -12,6 +12,20 @@ See [action.yml](action.yml)
 
 <!-- TODO: document custom workflow -->
 
+# Artifact validation
+
+While using this action is optional, we highly recommend it since it takes care of producing (mostly) valid artifacts.
+
+A Pages artifact must:
+
+- Be called `github-pages`
+- Be a single [`gzip` archive][gzip] containing a single [`tar` file][tar]
+
+The [`tar` file][tar] must:
+
+- be under 10GB in size
+- not contain any symbolic or hard links
+
 # Release instructions
 
 In order to release a new version of this Action:
@@ -36,4 +50,6 @@ The scripts and documentation in this project are released under the [MIT Licens
 <!-- references -->
 [pages]: https://pages.github.com
 [draft-release]: .github/workflows/draft-release.yml
-[release]: .github/workflows/release.yml
\ No newline at end of file
+[release]: .github/workflows/release.yml
+[gzip]: https://en.wikipedia.org/wiki/Gzip
+[tar]: https://en.wikipedia.org/wiki/Tar_(computing)
\ No newline at end of file
diff --git a/action.yml b/action.yml
index c97901d..b49e7b8 100644
--- a/action.yml
+++ b/action.yml
@@ -1,14 +1,14 @@
-name: 'Upload Pages artifact'
-description: 'A composite action that prepares your static assets to be deployed to GitHub Pages'
+name: "Upload Pages artifact"
+description: "A composite action that prepares your static assets to be deployed to GitHub Pages"
 inputs:
   path:
-    description: 'Path of the directoring containing the static assets.'
+    description: "Path of the directoring containing the static assets."
     required: true
-    default: '_site/'
+    default: "_site/"
   retention-days:
-    description: 'Duration after which artifact will expire in days.'
+    description: "Duration after which artifact will expire in days."
     required: false
-    default: '1'
+    default: "1"
 runs:
   using: composite
   steps: