Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added workflow to commit changes (.R files under R/) made in master to gh-pages #37

Merged
merged 1 commit into from Jun 10, 2021
Merged

Conversation

Anirban166
Copy link
Collaborator

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

  • An important note for future edits: clean must be always set to false (default is true) for our case here, as when set as true, it would eradicate everything on the gh-pages branch which are not covered as changes!
  • While adding R files or changing the content in them does count as modifications, deleting them does not, i.e. to say file deletions won't trigger the workflow (not specific to just this though, but for all 'on: push' type events)
  • folder and target-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 specify folder: R and target folder: pkg/directlabels/R (apart from setting branch to dldoc).

@tdhock this is not a work-in-progress, so feel free to merge if it is okay!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants