ghPages Publisher allows you to upload your site to GithubPages.
To use the
ghPages publisher, you'll need to provide Orchid with a
githubToken containing a Personal Access Token
from Netlify. Since PATs are confidential and allow anyone who has it complete access to your account, you should set
this as an environment variable and add it to your Gradle orchid config from that variable rather than committing it to
After your PAT is set up, you'll need to set up your repo on GitHub with a
gh-pages branch. Orchid will initialize a
new local git repo and push it to this branch, overwriting anything currently in that branch.
username property is the user which issued the PAT, and it is also the organization hosting the repository on
GitHub. You can authenticate with a different user than is hosting the repository by setting the
Commit your site directly to Github Pages. It can even keep old versions of your site for versioning documentation.Default Config
# config.yml ... services: publications: stages: ghPages: branch: gh-pages commitEmail: orchid@orchid commitMessage: Deploy to GitHub Pages from Orchid. commitUsername: Orchid githubUrl: github.com latestDirName: latest publishType: CleanBranch repo: empty string username: empty string
The branch to push to.
The email on the commit.
||String||Deploy to GitHub Pages from Orchid.||
The commit message to attach to this deploy.
The username on the commit.
The URL for a self-hosted Github Enterprise installation.
The name of the 'latest' directory used for the VersionedBranchWithLatest publish type.
The type of publication to use for Github Pages.
The repository to push to, as [username/repo], or just [repo] to use the authenticating username.
The user or organization with push access to your repo, used for authenticating with GitHub.
All options passed to this object.
Manually set the order in which this publisher executes
Configure this item with additional options merged in from