Struct GitHubDeployer 

pub struct GitHubDeployer { /* private fields */ }

GitHub Pages deployer

Implementations

impl GitHubDeployer

pub fn new(repo_name: impl Into<String>) -> Self

Create a new deployer with the given repository name

pub fn description(self, desc: impl Into<String>) -> Self

Set the repository description

pub fn public(self, public: bool) -> Self

Set whether the repository should be public

pub fn force(self, force: bool) -> Self

Set whether to force overwrite existing repository

pub fn check_prerequisites(&self) -> Result<Prerequisites>

Check deployment prerequisites

pub fn check_size(&self, bundle_dir: &Path) -> Result<SizeCheck>

Check size of bundle directory

pub fn deploy<P: AsRef<Path>>( &self, bundle_dir: P, progress: impl FnMut(&str, &str), ) -> Result<DeployResult>

Deploy bundle to GitHub Pages

Arguments

• bundle_dir - Path to the site/ directory from bundle builder
• progress - Progress callback (phase, message)

Trait Implementations

impl Default for GitHubDeployer

fn default() -> Self

Returns the “default value” for a type.