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.

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

merged 4 commits into from
Jan 2, 2020

Conversation

ericsciple
Copy link
Contributor

@ericsciple ericsciple commented Jan 2, 2020

fixes #125
fixes #126


# 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.

@@ -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

README.md Outdated Show resolved Hide resolved
- 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

@ericsciple ericsciple merged commit f466b96 into master Jan 2, 2020
@ericsciple ericsciple deleted the users/ericsciple/m164docs branch January 2, 2020 20:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Not a git repository error with checkout v2 fatal: refusing to merge unrelated histories
2 participants