Update action.yml

This partially fixes #940 by updating the description to match the request. However I'm assuming the runner adds in the `Action` part by truncating the description? cc @bryanmacfarlane

.github/workflows/test.yml

@@ -1,19 +0,0 @@
-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: ./
-      with:
-        ref: master

CHANGELOG.md

@@ -1,13 +0,0 @@
-# Changelog
-
-## Unreleased Changes
-- N/A
-
-## v1.2.0
-- Reverted the breaking behavior change in v1.1.0 that broke custom authentication flows
-
-## v1.1.0 (Not reccomended for use, this functionality will be ported to the 2.0 update)
-- 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
-
-## v1.0.0
-- Initial Release of the checkout action

README.md

@@ -1,61 +1,22 @@
-<p align="center">
+# checkout
-  <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>
 
-# Checkout
+This action checks out your repository so that your workflow operates from the root of the repository
-
-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@v1
+- uses: actions/checkout@master
-- uses: actions/setup-node@v1
+- uses: actions/setup-node@master
   with:
-    node-version: 10.x 
+    version: 10.x 
 - run: npm install
 - run: npm test
 ```
 
-By default, the branch or tag ref that triggered the workflow will be checked out. 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/master
-    token: ${{ secrets.GitHub_PAT }} # `GitHub_PAT` is a secret contains your PAT.
-```
-> - `${{ github.token }}` is scoped to the current repository, so if you want to checkout another repository that is private you will need to provide your own [PAT](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line).
-
-## Checkout private submodules
-```yaml
-- uses: actions/checkout@v1
-  with:
-    submodules: true # 'recursive' 'true' or 'false'
-    token: ${{ secrets.GitHub_PAT }} # `GitHub_PAT` is a secret contains your PAT.
-```
-> - Private submodules must be configured via `https` not `ssh`.
-> - `${{ github.token }}` only has permission to the workflow triggering repository. If the repository contains any submodules that come from private repositories, you will need to add your [PAT](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line) as secret and use the secret in `with.token` to make the `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 encrypted secrets](https://help.github.com/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)
-
 # License
 
 The scripts and documentation in this project are released under the [MIT License](LICENSE)

action.yml

@@ -1,5 +1,5 @@
 name: 'Checkout'
-description: 'Checkout a Git 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: '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'
+    description: 'Directory containing files to upload'
   lfs:
     description: 'Whether to download Git-LFS files; defaults to false'
   fetch-depth:
@@ -19,5 +19,4 @@ inputs:
   path:
     description: 'Optional path to check out source code'  
 runs:
-  # Plugins live on the runner and are only available to a certain set of first party actions.
   plugin: 'checkout'