Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/casperdcl/push-dir
Cleanly push directory contents to a branch
https://github.com/casperdcl/push-dir
actions deployment github-actions github-pages static-site
Last synced: 6 days ago
JSON representation
Cleanly push directory contents to a branch
- Host: GitHub
- URL: https://github.com/casperdcl/push-dir
- Owner: casperdcl
- License: other
- Created: 2021-09-11T20:12:47.000Z (about 3 years ago)
- Default Branch: v1
- Last Pushed: 2022-10-14T21:07:33.000Z (about 2 years ago)
- Last Synced: 2024-10-11T12:01:56.431Z (about 1 month ago)
- Topics: actions, deployment, github-actions, github-pages, static-site
- Homepage:
- Size: 20.5 KB
- Stars: 4
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
GitHub Action: Push Directory
=============================
[](https://github.com/casperdcl/push-dir/actions/workflows/test.yml)
Cleanly push directory contents to a branch. Particularly useful for `gh-pages` deployment.
## Example
```yaml
steps:
- uses: actions/checkout@v3
- run: build_site_command --output-dir static_site
- uses: casperdcl/push-dir@v1
with:
message: update static site
branch: gh-pages
dir: static_site
history: false
cname: my.domain.com
nojekyll: true
```
## Why
Perfect for e.g. `gh-pages` deployment.
- Supports pushing the contents of a directory to a branch
- Supports discarding branch history
- Uses a blazing fast native GitHub composite action
- Has the entirety of the code in a [single file](https://github.com/casperdcl/push-dir/blob/master/action.yml), making it very easy to review
+ If you are [extremely security conscious](https://github.com/casperdcl/deploy-pypi/issues/6#issuecomment-721954322) you can use a commit SHA of a version you've manually reviewed (e.g. `uses: casperdcl/push-dir@`[67a9d1d](https://github.com/casperdcl/push-dir/commit/67a9d1d4123e2e4978ad6ef8a86efaab2300fdc5))
The main alternatives GitHub Actions
[gh-pages-deploy](https://github.com/marketplace/actions/gh-pages-deploy) and
[github-push](https://github.com/marketplace/actions/github-push) currently do
not offer the benefits above.
Other features (supported by some of the alternatives) include:
- Custom committer name & email
- Custom commit message
- Force pushing
- `CNAME` & `.nojekyll` conveniences for GitHub pages
## Inputs
```yaml
message:
description: Commit message
required: true
branch:
description: Branch to push to
required: true
dir:
description: Directory to push
default: .
required: false
force:
description: Set to "true" to force push
required: false
history:
description: |
Set to "false" to discard any prior commits on the `branch`
(Note: "false" will override `force` to "true")
default: true
required: false
cname:
description: Text to inject into a `CNAME` file
default: ''
required: false
nojekyll:
description: Set to "true" to add a `.nojekyll` file
required: false
name:
description: Git committer name
required: false
email:
description: Git committer email
required: false
```