Skip to content

Update V2 Beta Docs #92

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

Closed
wants to merge 1 commit into from
Closed

Update V2 Beta Docs #92

wants to merge 1 commit into from

Conversation

thboop
Copy link
Contributor

@thboop thboop commented Dec 4, 2019

No description provided.

@thboop thboop requested a review from ericsciple December 4, 2019 14:18
@@ -3,6 +3,7 @@
</p>

# Checkout V2 beta
The Checkout V2 beta is now available! You have automatically upgraded if you bound to the `master` branch. If you did not mean to upgrade, please bind to `uses: actions/checkout@v1`. Please see the [action versioning docs](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md) for more information.
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we need to do this since the examples all reference @v2-beta?

This makes me feel like the content is leading with a technical note, rather than substance about the value of checkout v2.

Personal preference, I lean lean toward concise docs. I aim for skimmability (not a word, is now)

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 viewed it as a short term note just to help those users who auto-upgraded on accident and came to this repo to see what happened, but I get your point. I'll close this pr.

@@ -66,15 +67,15 @@ Refer [here](https://github.com/actions/checkout/blob/v1/README.md) for previous
## Checkout a different branch

```yaml
- uses: actions/checkout@preview
- uses: actions/checkout@v2-beta
Copy link
Contributor

Choose a reason for hiding this comment

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

i also have a pr to fix this: #90

many users seem to be interested in checking out the HEAD commit of a PR rather than the merge commit. Seemed like an example was warranted (since it's otherwise not intuitive how to achieve it)

@thboop thboop closed this Dec 4, 2019
@thboop thboop deleted the users/thboop/clarifyReadme branch December 4, 2019 16:07
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.

2 participants