Merge pull request #1 from actions/doc

Add license + basic doc

.github/CODEOWNERS

@@ -0,0 +1,2 @@
+# Default PR reviewers
+* @actions/pages

.github/release-drafter.yml

@@ -0,0 +1,40 @@
+---
+name-template: "v$RESOLVED_VERSION"
+tag-template: "v$RESOLVED_VERSION"
+template: |
+  # Changelog
+
+  $CHANGES
+
+  See details of [all code changes](https://github.com/$OWNER/$REPOSITORY/compare/$PREVIOUS_TAG...v$RESOLVED_VERSION) since previous release.
+categories:
+  - title: "🚀 Features"
+    labels:
+      - "feature"
+      - "enhancement"
+  - title: "🐛 Bug Fixes"
+    labels:
+      - "fix"
+      - "bugfix"
+      - "bug"
+  - title: "🧰 Maintenance"
+    labels:
+      - "infrastructure"
+      - "automation"
+      - "documentation"
+  - title: "🏎 Performance"
+    label: "performance"
+change-template: "- $TITLE @$AUTHOR (#$NUMBER)"
+version-resolver:
+  major:
+    labels:
+      - "type: breaking"
+  minor:
+    labels:
+      - "type: enhancement"
+  patch:
+    labels:
+      - "type: bug"
+      - "type: maintenance"
+      - "type: documentation"
+  default: patch

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 GitHub, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,13 +1,16 @@
-# configure-pages
+# Configure-Pages
 
-An action to enable Pages and extract metadata.
+An action to enable Pages and extract various metadata about a site. It can also be used to configure various static site generators we support as [starter workflows][starter-workflows].
 
+# Usage
+
+See [action.yml](action.yml) and the [Pages starter workflows][starter-workflows].
 
 # Release instructions
 
 In order to release a new version of this Action:
 
-1. Locate the semantic version of the upcoming release (a draft is maintained by the [`draft-release` workflow](draft-release.yml))
+1. Locate the semantic version of the upcoming release (a draft is maintained by the [`draft-release` workflow][draft-release])
 
 2. Push a matching tag, for instance for `v0.1.0`:
 
@@ -16,6 +19,15 @@ In order to release a new version of this Action:
    git push origin v0.1.0
    ```
 
-3. Publish the draft release (the major tag such as `v0` will be created/updated by the [`release` workflow](release.yml))
+3. Publish the draft release (the major tag such as `v0` will be created/updated by the [`release` workflow][release])
 
    ⚠️ Environment approval is required.
+
+# License
+
+The scripts and documentation in this project are released under the [MIT License](LICENSE).
+
+<!-- references -->
+[starter-workflows]: https://github.com/actions/starter-workflows/tree/main/pages
+[draft-release]: .github/workflows/draft-release.yml
+[release]: .github/workflows/release.yml

action.yml

@@ -1,14 +1,14 @@
-name: 'Get the Pages base URL'
-description: 'Get the base URL where the GitHub Pages site will be hosted'
+name: "Configure Pages"
+description: "An action to enable Pages and extract various metadata about a site. It can also be used to configure various static site generators we support as starter workflows."
 runs:
-  using: 'node16'
-  main: 'dist/index.js'
+  using: "node16"
+  main: "dist/index.js"
 inputs:
-  static_site_generator: 
-    description: 'static site generator types. We currently support nuxt, next and gatsby'
+  static_site_generator:
+    description: "Optional static site generator to attempt to configure (nuxt, next or gatsby)"
     required: false
   token:
-    description: 'GitHub token'
+    description: "GitHub token"
     default: ${{ github.token }}
     required: true
 outputs: