Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/guillaumefalourd/clone-github-repo-action
Github Action to clone a public or private Github repository and access its content on others repositories' workflows ♻️
https://github.com/guillaumefalourd/clone-github-repo-action
clone-repos github github-action hacktoberfest useful utilities workflows
Last synced: 2 months ago
JSON representation
Github Action to clone a public or private Github repository and access its content on others repositories' workflows ♻️
- Host: GitHub
- URL: https://github.com/guillaumefalourd/clone-github-repo-action
- Owner: GuillaumeFalourd
- License: apache-2.0
- Created: 2021-05-07T13:32:14.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-12-14T14:25:36.000Z (about 1 year ago)
- Last Synced: 2024-04-19T21:25:14.041Z (9 months ago)
- Topics: clone-repos, github, github-action, hacktoberfest, useful, utilities, workflows
- Homepage: https://github.com/marketplace/actions/clone-github-repo-action
- Size: 57.6 KB
- Stars: 41
- Watchers: 3
- Forks: 15
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Clone Github Repository Action
[](https://github.com/search?o=desc&q=GuillaumeFalourd+clone-github-repo-action+path%3A.github%2Fworkflows+language%3AYAML&s=&type=Code) [](https://github.com/GuillaumeFalourd/clone-github-repo-action/actions/workflows/public-repo.yml) [](https://github.com/GuillaumeFalourd/clone-github-repo-action/actions/workflows/private-repo.yml)
Github Action to clone a **public** or **private** Github repository and access its content on others repositories' workflows.
## What changed with the action `v2` ?
This action `v2` is using a **composite action** to be compatible with all operating systems (the `v1` was using a **Dockerfile** that was only compatible with `ubuntu-*` runners).
### What changed with the action `v2.1` ?
You now have a new input parameter called `depth`, which is optional and has an empty default value. If you specify a depth value when using the action, it will be passed as the value for the **--depth** parameter of the git clone command. Otherwise, the clone will be done with the default depth, which is the full history.
### What changed with the action `v2.2` ?
You now have a new input parameter called `branch`, which is optional and uses `main` as default value. If you specify a branch value when using the action, it will be passed as the value for the **--branch** parameter of the git clone command.
### What changed with the action `v2.3` ?
You now have a new input parameter called `submodule`, which is optional and uses `false` as default value. If you specify the submodule value when using the action as `true`, it will clone the submodule along with the repository.
## How to use this action?
Create a new `.yml` file on your `.github/workflows` directory.
Field | Mandatory | Observation
------------ | ------------ | -------------
**owner** | YES | Ex: `octocat`
**repository** | YES | Ex: `clone-github-repo-action` |
**branch** | NO | Ex: `main` (default)
**depth** | NO | 1 `Ex: most recent commit`
**submodule** | NO | `false` or `true`
**access-token** | NO | [How to create a PAT](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token)
You can use one of those as reference:
- [Clone Public Repo Workflow](https://github.com/GuillaumeFalourd/clone-github-repo-action/blob/main/.github/workflows/public-repo.yml)
- [Clone Private Repo Workflow](https://github.com/GuillaumeFalourd/clone-github-repo-action/blob/main/.github/workflows/private-repo.yml)
### For a public repository (with depth)
```bash
- name: Clone GuillaumeFalourd/poc-github-actions PUBLIC repository
uses: GuillaumeFalourd/[email protected]
with:
depth: 1
branch: 'main'
owner: 'GuillaumeFalourd'
repository: 'poc-github-actions'
```
### For a private repository
To use this action to clone a `PRIVATE` repository the Github User/Admin has access to, it's necessary to create a [PERSONAL ACCESS TOKEN](https://github.com/settings/tokens) with `REPOSITORY` scopes.
```bash
- name: Clone GuillaumeFalourd/formulas-training PRIVATE repository
uses: GuillaumeFalourd/[email protected]
with:
owner: 'GuillaumeFalourd'
repository: 'formulas-training'
access-token: ${{ secrets.ACCESS_TOKEN }}
```
### Access repository content
After using this action in your workflow, you can use the following command to access the cloned repository content:
```bash
cd
```
#### Step Example
```bash
- name: Access cloned repository content
run: |
cd
ls -la
```
## Licensed
☞ This repository uses the [Apache License 2.0](https://github.com/GuillaumeFalourd/aws-cliaction/blob/main/LICENSE)
## Contributing
☞ [Guidelines](https://github.com/GuillaumeFalourd/clone-github-repo-action/blob/main/CONTRIBUTING.md)
(Made with [contributors-img](https://contrib.rocks))