Upgrade checkout to v1.1.0 to better support scripting git. (#56)

* Upgrade checkout to v1.1.0 to better support scripting git.

* add changelog

* Update README.md

* Add local testing yaml

* Add Status Badge to readme

.github/workflows/test.yml

@@ -0,0 +1,18 @@
+name: "test-local"
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+      - 'releases/*'
+
+jobs:
+  test:
+    strategy:
+      matrix:
+        os: [windows-latest, ubuntu-latest, macOS-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@master
+    - uses: ./
+    - run: git ls-remote --tags origin

README.md

@@ -1,22 +1,65 @@
-# checkout
+<p align="center">
+  <a href="https://github.com/actions/checkout"><img alt="GitHub Actions status" src="https://github.com/actions/checkout/workflows/test-local/badge.svg"></a>
+</p>
 
-This action checks out your repository so that your workflow operates from the root of the repository
+# Checkout
+
+This action checks out your repository to `$GITHUB_WORKSPACE`, so that your workflow can access the contents of your repository.
+
+By default, this is equivalent to running `git fetch` and `git checkout $GITHUB_SHA`, so that you'll always have your repo contents at the version that triggered the workflow.
+See [here](https://help.github.com/en/articles/events-that-trigger-workflows) to learn what `$GITHUB_SHA` is for different kinds of events.
 
 # Usage
 
 See [action.yml](action.yml)
 
 Basic:
+
 ```yaml
 steps:
-- uses: actions/checkout@master
-- uses: actions/setup-node@master
+- uses: actions/checkout@v1
+- uses: actions/setup-node@v1
   with:
-    version: 10.x 
+    node-version: 10.x 
 - run: npm install
 - run: npm test
 ```
 
+By default, the branch or tag ref that triggered the workflow will be checked out, `${{ github.token }}` will be used for any Git server authentication. If you wish to check out a different branch, a different repository or use different token to checkout, specify that using `with.ref`, `with.repository` and `with.token`:
+
+Checkout different branch from the workflow repository:
+```yaml
+- uses: actions/checkout@v1
+  with:
+    ref: some-branch
+```
+
+Checkout different private repository:
+```yaml
+- uses: actions/checkout@v1
+  with:
+    repository: myAccount/myRepository
+    ref: refs/heads/release
+    token: ${{ secrets.GitHub_PAT }} // `GitHub_PAT` is a secret contains your PAT.
+```
+
+Checkout private submodules:
+```yaml
+- uses: actions/checkout@v1
+  with:
+    submodules: recursive
+    token: ${{ secrets.GitHub_PAT }} // `GitHub_PAT` is a secret contains your PAT.
+```
+> - `with.token` will be used as `Basic` authentication header for https requests talk to https://github.com from `git(.exe)`, ensure those private submodules are configured via `https` not `ssh`.
+> - `${{ github.token }}` only has permission to the workflow triggering repository. If the repository contains any submodules that comes from private repository, you will have to add your PAT as secret and use the secret in `with.token` to make `checkout` action work.
+
+For more details, see [Contexts and expression syntax for GitHub Actions](https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions) and [Creating and using secrets (encrypted variables)](https://help.github.com/en/articles/virtual-environments-for-github-actions#creating-and-using-secrets-encrypted-variables)
+
+# Changelog
+
+## v1.1.0 (unreleased)
+- Persist `with.token` or `${{ github.token }}` into checkout repository's git config as `http.https://github.com/.extraheader=AUTHORIZATION: basic ***` to better support scripting git
+
 # License
 
 The scripts and documentation in this project are released under the [MIT License](LICENSE)

action.yml

@@ -1,5 +1,5 @@
 name: 'Checkout'
-description: 'Get sources from a GitHub repository.'
+description: 'Checkout a Git repository.'
 inputs: 
   repository:
     description: 'Repository name'
@@ -11,7 +11,7 @@ inputs:
     description: 'If true, execute `execute git clean -ffdx && git reset --hard HEAD` before fetching'
     default: true
   submodules:
-    description: 'Directory containing files to upload'
+    description: 'Whether to include submodules: false to exclude submodules, true to include only one level of submodules, or recursive to recursively clone submodules; defaults to false'
   lfs:
     description: 'Whether to download Git-LFS files; defaults to false'
   fetch-depth:
@@ -19,4 +19,5 @@ inputs:
   path:
     description: 'Optional path to check out source code'  
 runs:
-  plugin: 'checkout'
+  # Plugins live on the runner and are only available to a certain set of first party actions.
+  plugin: 'checkoutV1_1'