Commit graph

54 commits

Author SHA1 Message Date
Marco Accorinti
21ffcee746 update: README.md with new options, descriptions 2024-04-25 17:55:21 +02:00
Cory Miller
1d96c772d1
Add SSH user parameter (#1685)
* Add a configurable SSH user

* Update docs with param

* Indentation of readme

* formatting woes

* Update src/url-helper.ts

Co-authored-by: Josh Gross <joshmgross@github.com>

* Update action.yml

Co-authored-by: Josh Gross <joshmgross@github.com>

* Update genfiles

---------

Co-authored-by: Josh Gross <joshmgross@github.com>
2024-04-18 15:29:55 -04:00
Cory Miller
b4ffde65f4
Link to release page from what's new section (#1514) 2023-10-17 11:52:30 -04:00
Peter Bengtsson
8530928916
Correct link to GitHub Docs (#1511)
No hardcoded language in the URL and uses the correct docs.github.com domain.
2023-10-13 11:07:47 -04:00
Finley Garton
c533a0a4cf
Add support for partial checkout filters (#1396)
* added filter option & tests

* added build file

* fix test oversight

* added exit 1

* updated docs to specify override

* undo unneeded readme change

* set to undefined rather than empty string

* run git config in correct di

---------

Co-authored-by: Cory Miller <13227161+cory-miller@users.noreply.github.com>
2023-09-22 13:30:36 -04:00
Varun Sivapalan
72f2cec99f
Update README.md for V4 (#1452)
* Update README.md for V4

* Update actionReference in generate-docs.ts for v4
2023-09-05 09:21:52 -04:00
Simon Baird
8b5e8b7687
Support fetching without the --progress option (#1067)
Setting the `show-progress` option to false in the `with` section of the
workflow step will cause git fetch to run without `--progress`.

The motivation is to be able to suppress the noisy progress status
output which adds many hundreds of "remote: Counting objects: 85%
(386/453)" and similar lines in the workflow log.

This should be sufficient to resolve #894 and its older friends,
though the solution is different to the one proposed there because
it doesn't use the --quiet flag. IIUC git doesn't show the progress
status by default since the output is not a terminal, so that's why
removing the --progress option is all that's needed.

Adding the --quiet flag doesn't make a lot of difference once the
--progress flag is removed, and actually I think using --quiet would
suppress some other more useful output that would be better left
visible.

Signed-off-by: Simon Baird <sbaird@redhat.com>
2023-09-01 14:19:18 -04:00
Robert Wieczoreck
7739b9ba2e
Add option to fetch tags even if fetch-depth > 0 (#579)
* Add option to fetch tags even if fetch-depth > 0

* Add jest tests for fetchDepth and fetchTags options
2023-08-16 16:34:54 -04:00
Johannes Schindelin
d106d4669b
Add support for sparse checkouts (#1369)
* Add support for sparse checkouts

* sparse-checkout: optionally turn off cone mode

While it _is_ true that cone mode is the default nowadays (mainly for
performance reasons: code mode is much faster than non-cone mode), there
_are_ legitimate use cases where non-cone mode is really useful.

Let's add a flag to optionally disable cone mode.

Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>

* Verify minimum Git version for sparse checkout

The `git sparse-checkout` command is available only since Git version
v2.25.0. The `actions/checkout` Action actually supports older Git
versions than that; As of time of writing, the minimum version is
v2.18.0.

Instead of raising this minimum version even for users who do not
require a sparse checkout, only check for this minimum version
specifically when a sparse checkout was asked for.

Suggested-by: Tingluo Huang <tingluohuang@github.com>
Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>

* Support sparse checkout/LFS better

Instead of fetching all the LFS objects present in the current revision
in a sparse checkout, whether they are needed inside the sparse cone or
not, let's instead only pull the ones that are actually needed.

To do that, let's avoid running that preemptive `git lfs fetch` call in
case of a sparse checkout.

An alternative that was considered during the development of this patch
(and ultimately rejected) was to use `git lfs pull --include <path>...`,
but it turned out to be too inflexible because it requires exact paths,
not the patterns that are available via the sparse checkout definition,
and that risks running into command-line length limitations.

Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>

---------

Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
Co-authored-by: Daniel <daniel.fernandez@feverup.com>
2023-06-09 09:08:21 -04:00
Ryan van Zeben
3ba5ee6fac
Add in explicit reference to private checkout options (#1050) 2022-12-16 16:06:54 -05:00
Scott Brenner
1f9a0c22da
README - fix status badge (#967) 2022-10-17 09:49:29 -04:00
Peter Murray
e6d535c99c
Inject GitHub host to be able to clone from another GitHub instance (#922)
* Adding the ability to specify the GitHub Server URL and allowing for it to differ from the Actions workflow host

* Adding tests for injecting the GitHub URL

* Addressing code review comments for PR #922
2022-09-26 12:34:52 -04:00
Tingluo Huang
0ffe6f9c55
Add set-safe-directory input to allow customers to take control. (#770)
* Add set-safe-directory input to allow customers to take control.
2022-04-20 21:37:43 -04:00
Thomas Boop
a12a3943b4
update readme for v3 (#708)
* update readme for v3

* update readme with changes

* nit grammar
2022-03-01 12:46:45 -05:00
Ameya Lokare
230611dbd0
Change secret name for PAT to not start with GITHUB_ (#623)
Github doesn't allow secret names that start with `GITHUB_` (case insensitive). Update README to choose a different prefix (GH).
2021-11-02 16:20:59 -05:00
eric sciple
592cf69a22
Update README.md 2020-07-14 16:30:57 -04:00
eric sciple
a4b69b4886
Update README.md 2020-07-14 13:08:52 -04:00
eric sciple
1433f62caa
update default branch (#305) 2020-07-14 09:23:30 -04:00
eric sciple
61b9e3751b
improve description for fetch-depth (#301) 2020-07-12 21:02:24 -04:00
eric sciple
00a3be8934
determine default branch (#278) 2020-06-16 13:41:01 -04:00
eric sciple
e52d022eb5
Fetch all history for all tags and branches when fetch-depth=0 (#258) 2020-05-27 09:54:28 -04:00
eric sciple
df86c829eb
fix readme (#251) 2020-05-20 10:20:52 -04:00
eric sciple
574281d34c update readme 2020-03-19 22:17:25 -04:00
Jef LeCompte
fbb30c60ab
Removed doc based on new changes (#192) 2020-03-19 22:03:41 -04:00
eric sciple
9a3a9ade82
persist core.sshCommand for submodules (#184)
* persist core.sshCommand for submodules

* update verbiage; add comments

* fail when submodules or ssh-key and fallback to REST API
2020-03-12 11:42:38 -04:00
eric sciple
b2e6b7ed13
add ssh support (#163) 2020-03-11 15:55:17 -04:00
eric sciple
422dc45671
add support for submodules (#173) 2020-03-05 14:21:59 -05:00
Christopher Sexton
77904fd431
Handle submodules with SSH URLs (#140)
* Handle submodules with SSH URLs

This is just a documentation change, explaining how to fix submodules
that are configured to use SSH URLs instead of HTTPS URLs. Spent a while
banging my head on the wall and hope this saves someone else the pain.

This is helpful for teams that use the SSH protocol for local
development so don't want to change the mechanism that pulls in the
submodules. Using `insteadOf` seems a bit nicer than than setting up a
deploy keypair.

* SSH submodules

Co-authored-by: Chris Patterson <chrispat@github.com>
2020-02-13 14:44:37 -05:00
eric sciple
bc50a995b8
Add link to doc for creating and using encyrpted secrets (#123) 2020-01-03 12:32:17 -05:00
eric sciple
f466b96953
improve summary (#127) 2020-01-02 15:40:10 -05:00
eric sciple
c85684db76
example fetch all history for all tags and branches (#115) 2019-12-16 10:45:02 -05:00
eric sciple
299dd5064e
add more scenarios (#112) 2019-12-13 16:39:47 -05:00
eric sciple
722adc63f1
update examples to reference v2 tag (#110) 2019-12-13 00:00:48 -05:00
eric sciple
c170eefc26
add input persist-credentials (#107) 2019-12-12 13:49:26 -05:00
eric sciple
a572f640b0
fallback to REST API to download repo (#104) 2019-12-12 13:16:16 -05:00
Riddhesh Sanghvi
cab31617d8 Document update: Checkout PR head sha (#102) 2019-12-10 11:17:38 -05:00
eric sciple
5881116d18
Update README.md 2019-12-05 22:10:31 -05:00
Edward Thomson
7990b10a0c Update description (#65) 2019-12-04 23:43:03 -05:00
eric sciple
01a434328a
document scenario: checkout the head commit of a PR (#90) 2019-12-04 10:12:10 -05:00
eric sciple
4817b449b0
clarify name with owner (#87) 2019-12-03 16:47:19 -05:00
eric sciple
cc70598ce8
Update README.md 2019-12-03 11:35:57 -05:00
eric sciple
8461dbfed3
update readme (#82) 2019-12-03 11:26:12 -05:00
eric sciple
e347bba93b
Convert checkout to a regular action (#70) 2019-12-03 10:28:59 -05:00
Thomas Boop
50fbc622fc
Reverted Changes to Git Config and Authentication (#64)
v1.2.0 Release - Reverted changes to git just works authentication
2019-11-21 11:04:30 -05:00
Rachael Sewell
e8bd1dffb6 Update help docs link (#68) 2019-11-20 13:36:26 -05:00
Tingluo Huang
0b496e91ec 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
2019-10-25 10:52:59 -04:00
Zeke Sikelianos
0963d3b35f add docs about checking out the triggering ref (#21)
* add docs about checking out the triggering ref

* clarify checkout behavior
2019-09-05 11:42:49 -04:00
Max Held
a14471d838 clarify language on working directory (#9)
* clarify language

I guess this action doesn't technically make sure that my working directory is `$GITHUB_WORKSPACE`, so this might be more precise?

* fix repetition
2019-08-21 21:39:05 -04:00
Doug Moscrop
cacfc4155d Change version to node-version (#12)
version is deprecated and replaced by node-version
2019-08-16 10:59:11 -04:00
Ahmet Alp Balkan
6e6328ef28 README: Environment variable typo fix (#11) 2019-08-16 10:56:22 -04:00