Added workflow to commit changes (.R files under R/) made in master to gh-pages #37
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Workflow Guide
This workflow is triggered on commits which involve changes to the R files contained within the R/ directory for the master branch, may it be from a direct push, or one from a pull request (authored by anyone). These modifications are then brought under the R/ folder on the gh-pages branch (thus keeping the .R files present there up-to-date with the ones on the master branch) with the help of this action.
Apart from such specific changes, a commit might involve other changes as well, in which case too, only the modifications (includes addition of new .R files) made to R files inside the R/ folder will be carry-forwarded to gh-pages, since the deployment is made based on my designated path filter (
paths: - R/**.R
).Caveats
clean
must be always set tofalse
(default istrue
) for our case here, as when set astrue
, it would eradicate everything on the gh-pages branch which are not covered as changes!folder
andtarget-folder
may look the same here, but they are different in the sense that the later requires a full-path specification. For instance, if I were to make this same workflow for carrying over changes from master to dldoc, I would need to specifyfolder: R
andtarget folder: pkg/directlabels/R
(apart from settingbranch
todldoc
).@tdhock this is not a work-in-progress, so feel free to merge if it is okay!