import * as pulumi from "@pulumi/pulumi"; import * as inputs from "./types/input"; import * as outputs from "./types/output"; /** * This resource allows you to manage GitHub Pages for a repository. See the * [documentation](https://docs.github.com/en/pages/getting-started-with-github-pages/about-github-pages) * for details on GitHub Pages. * * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. OAuth app tokens and personal access tokens (classic) need the repo scope to use this resource. * * ## Example Usage * * ### Legacy Build Type * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as github from "@pulumi/github"; * * const example = new github.Repository("example", { * name: "my-repo", * visibility: "public", * autoInit: true, * }); * const exampleRepositoryPages = new github.RepositoryPages("example", { * repository: example.name, * buildType: "legacy", * source: { * branch: "main", * path: "/", * }, * }); * ``` * * ### Workflow Build Type (GitHub Actions) * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as github from "@pulumi/github"; * * const example = new github.Repository("example", { * name: "my-repo", * visibility: "public", * autoInit: true, * }); * const exampleRepositoryPages = new github.RepositoryPages("example", { * repository: example.name, * buildType: "workflow", * }); * ``` * * ### With Custom Domain * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as github from "@pulumi/github"; * * const example = new github.Repository("example", { * name: "my-repo", * visibility: "public", * autoInit: true, * }); * const exampleRepositoryPages = new github.RepositoryPages("example", { * repository: example.name, * buildType: "legacy", * cname: "example.com", * httpsEnforced: true, * source: { * branch: "main", * path: "/docs", * }, * }); * ``` * * ## Import * * GitHub repository pages can be imported using the `repository-slug`, e.g. * * ```sh * $ pulumi import github:index/repositoryPages:RepositoryPages example my-repo * ``` */ export declare class RepositoryPages extends pulumi.CustomResource { /** * Get an existing RepositoryPages resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: RepositoryPagesState, opts?: pulumi.CustomResourceOptions): RepositoryPages; /** * Returns true if the given object is an instance of RepositoryPages. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is RepositoryPages; /** * The API URL of the GitHub Pages resource. */ readonly apiUrl: pulumi.Output; /** * The GitHub Pages site's build status (e.g., `building` or `built`). */ readonly buildStatus: pulumi.Output; /** * The type of GitHub Pages site to build. Can be `legacy` or `workflow`. Defaults to `legacy`. */ readonly buildType: pulumi.Output; /** * The custom domain for the repository. */ readonly cname: pulumi.Output; /** * Whether the rendered GitHub Pages site has a custom 404 page. */ readonly custom404: pulumi.Output; /** * The absolute URL (with scheme) to the rendered GitHub Pages site. */ readonly htmlUrl: pulumi.Output; /** * Whether HTTPS is enforced for the GitHub Pages site. GitHub Pages sites serve over HTTPS by default; this setting only applies when a custom domain (`cname`) is configured. Requires `cname` to be set. */ readonly httpsEnforced: pulumi.Output; /** * Whether the GitHub Pages site is public. */ readonly public: pulumi.Output; /** * The repository name to configure GitHub Pages for. */ readonly repository: pulumi.Output; /** * The ID of the repository. */ readonly repositoryId: pulumi.Output; /** * The source branch and directory for the rendered Pages site. Required when `buildType` is `legacy`. See Source below for details. */ readonly source: pulumi.Output; /** * Create a RepositoryPages resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: RepositoryPagesArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering RepositoryPages resources. */ export interface RepositoryPagesState { /** * The API URL of the GitHub Pages resource. */ apiUrl?: pulumi.Input; /** * The GitHub Pages site's build status (e.g., `building` or `built`). */ buildStatus?: pulumi.Input; /** * The type of GitHub Pages site to build. Can be `legacy` or `workflow`. Defaults to `legacy`. */ buildType?: pulumi.Input; /** * The custom domain for the repository. */ cname?: pulumi.Input; /** * Whether the rendered GitHub Pages site has a custom 404 page. */ custom404?: pulumi.Input; /** * The absolute URL (with scheme) to the rendered GitHub Pages site. */ htmlUrl?: pulumi.Input; /** * Whether HTTPS is enforced for the GitHub Pages site. GitHub Pages sites serve over HTTPS by default; this setting only applies when a custom domain (`cname`) is configured. Requires `cname` to be set. */ httpsEnforced?: pulumi.Input; /** * Whether the GitHub Pages site is public. */ public?: pulumi.Input; /** * The repository name to configure GitHub Pages for. */ repository?: pulumi.Input; /** * The ID of the repository. */ repositoryId?: pulumi.Input; /** * The source branch and directory for the rendered Pages site. Required when `buildType` is `legacy`. See Source below for details. */ source?: pulumi.Input; } /** * The set of arguments for constructing a RepositoryPages resource. */ export interface RepositoryPagesArgs { /** * The type of GitHub Pages site to build. Can be `legacy` or `workflow`. Defaults to `legacy`. */ buildType?: pulumi.Input; /** * The custom domain for the repository. */ cname?: pulumi.Input; /** * Whether HTTPS is enforced for the GitHub Pages site. GitHub Pages sites serve over HTTPS by default; this setting only applies when a custom domain (`cname`) is configured. Requires `cname` to be set. */ httpsEnforced?: pulumi.Input; /** * Whether the GitHub Pages site is public. */ public?: pulumi.Input; /** * The repository name to configure GitHub Pages for. */ repository: pulumi.Input; /** * The source branch and directory for the rendered Pages site. Required when `buildType` is `legacy`. See Source below for details. */ source?: pulumi.Input; } //# sourceMappingURL=repositoryPages.d.ts.map