Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

improve summary #127

Merged
merged 4 commits into from
Jan 2, 2020
Merged

improve summary #127

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a8ee10b
improve summary
ericsciple Jan 2, 2020
e95bfc9
.
ericsciple Jan 2, 2020
3c73ba7
.
ericsciple Jan 2, 2020
ee06039
.
ericsciple Jan 2, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 8 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,27 +6,26 @@

This action checks-out your repository under `$GITHUB_WORKSPACE`, so your workflow can access it.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The existing summary does not have enough details and folks are getting tripped up by the fetch-depth 1 default


By default, the repository that triggered the workflow is checked-out, for the ref/SHA that triggered the event.
Only a single commit is fetched by default, for the ref/SHA that triggered the workflow. Set `fetch-depth` to fetch more history. Refer [here](https://help.github.com/en/articles/events-that-trigger-workflows) to learn which commit `$GITHUB_SHA` points to for different events.

Refer [here](https://help.github.com/en/articles/events-that-trigger-workflows) to learn which commit `$GITHUB_SHA` points to for different events.
The auth token is persisted in the local git config. This enables your scripts to run authenticated git commands. The token is removed during post-job cleanup. Use the input `persist-credentials` to opt-out.
ericsciple marked this conversation as resolved.
Show resolved Hide resolved

When Git 2.18 or higher is not in your PATH, falls back to the REST API to download the files.

# What's new

- Improved fetch performance
- The default behavior now fetches only the commit being checked-out
- Improved performance
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I simplified the What's new section to make it easier to skim

Also the summary is more verbose now, so I didn't want to repeat all details.

- Fetches only a single commit by default
- Script authenticated git commands
- Persists the input `token` in the local git config
- Enables your scripts to run authenticated git commands
- Post-job cleanup removes the token
- Opt out by setting the input `persist-credentials: false`
- Auth token persisted in the local git config
- Creates a local branch
- No longer detached HEAD when checking out a branch
- A local branch is created with the corresponding upstream branch set
- Improved layout
- The input `path` is always relative to $GITHUB_WORKSPACE
- Aligns better with container actions, where $GITHUB_WORKSPACE gets mapped in
- Fallback to REST API download
- When Git 2.18 or higher is not in the PATH, the REST API will be used to download the files
- When using a job container, the container's PATH is used
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this tripped up a customer migrating from v1

- Removed input `submodules`

Refer [here](https://github.com/actions/checkout/blob/v1/README.md) for previous versions.
Expand Down