API Reference

CLI()

check_file_on_github(
    access_token::String,
    owner_name::String,
    repo_name::String,
    branch_name::String,
    repo_path::String
) -> Bool

check_repo(
    access_token::String,
    owner_name::String,
    repo_name::String
) -> Bool

check_status_code() -> Bool

commit_file_on_github(
    access_token::String,
    owner_name::String,
    repo_name::String,
    branch_name::String,
    commit_message::String,
    path::String,
    content::String
)

Signature:

commit_files_on_github(
    access_token::String,
    owner_name::String,
    repo_name::String,
    branch_name::String,
    commit_message::String,
    paths_and_contents::Dict{String, String}
) -> GitHub.Reference

Example:

access_token = "YOUR_ACCESS_TOKEN"
owner_name = "user"
repo_name = "my-github-repo"
branch_name = "main"
commit_message = "Update hello1.md and hello2.md"
paths_and_contents = Dict(
    "hello1.md" => "Hello, 1",
    "hello2.md" => "Hello, 2",
)

PkgFactory.commit_files_on_github(
    access_token,
    owner_name,
    repo_name,
    branch_name,
    commit_message,
    paths_and_contents,
)

create_branch_gh_pages(
    access_token::String,
    owner_name::String,
    repo_name::String
) -> Bool

create_package_with_jll(
    access_token::String,
    owner_name::String,
    repo_name::String,
    author_names::Vector{String},
    package_description::String;
    commit_message
) -> Bool

create_repo(
    access_token::String,
    owner_name::String,
    repo_name::String,
    package_description::String
) -> Union{Nothing, Bool, Float64, Int64, String, JSON3.Array, JSON3.Object}

device_flow_begin(client_id::String) -> JSON3.Object

device_flow_end(
    client_id::String,
    device_code::String
) -> Union{Nothing, Bool, Float64, Int64, String, JSON3.Array, JSON3.Object}

generate_template_dict(
    owner_name::String,
    repo_name::String,
    author_names::Vector{String},
    package_description::String
) -> Dict{String, String}

get_codecov_url(
    owner_name::String,
    repo_name::String
) -> String

get_file_on_github(
    access_token::String,
    owner_name::String,
    repo_name::String,
    repo_path::String
) -> GitHub.Content

get_user_domain(access_token::String) -> Any

gh_executable() -> Any

git_executable() -> Any

list_files() -> Vector{String}

load_file(path::String) -> String

set_codecov(
    access_token::String,
    owner_name::String,
    repo_name::String,
    codecov_token::String
) -> Bool

set_deploy_key(
    access_token::String,
    owner_name::String,
    repo_name::String
) -> Bool

set_repository_secret(
    access_token::String,
    owner_name::String,
    repo_name::String,
    secret_name::String,
    secret_value::String
) -> Bool

Signature:

update_template(
    owner_name::String,
    repo_name::String,
    author_names::Vector{String}
)

Example:

PkgFactory.update_template("OWNER_NAME", "template", ["AUTHOR1", "AUTHOR2"])

This function verifies the package name according to the package naming rules of Pkg.jl and the automatic merging guidelines of RegistryCI.jl.

verify_package_name(package_name::String) -> String