A GitHub Action to push any local file changes, including new files, back to supplied branch name.
This action is useful to put after other actions that modify files in the local checkout that you'd then like to persist back into the repository.
Usage:
- uses: mikeal/publish-to-github-action@master
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
BRANCH_NAME: '' #optional defaults to master
If you can get away with only ever writing new files, instead of updating them, you won’t regret it ;) Every time you update a file you retain the history of the file. Over time this can become quite large and contain a lot of duplicate data, even when using Git LFS as described below. The only way to garbage collect this historical data is to use a hefty Java program called BFG to re-write the history.
For large data files, or if you have a lot of data, this action comes with the dependencies required for Git LFS, so as long as you've initialized and configured LFS for the files you're adding they will be added and pushed via Git LFS. This is particularly helpful if you are running into GitHub's 1GB data limit.
One thing to note is that files in Git LFS are stored out of the repository and then pulled in by LFS specific tools. This means that the default git checkout in an action won't have the real file data, it will have file stubs that tell LFS how to download the files. If your action needs these files to be fully available you have two options.
- Set the
lfsoption to true in your checkout action. This will download all the LFS files, which is rarely ideal and is a great way to blow out your LFS transfer limit ;) - Prior to reading the files, run
git lfs installandgit pull --include files-i-want/*in your action. This will pull out only the selected files.