pub struct GitHubProjectsConfig {
pub owner: String,
pub project_number: u32,
pub repository: Option<String>,
pub token_env: String,
pub endpoint: String,
pub status_mapping: BTreeMap<String, Option<StatusTargetConfig>>,
pub pacing: PacingConfig,
}Expand description
Configuration for one GitHub Projects v2 board.
Fields§
§owner: StringLogin of the user or organization which owns the board.
project_number: u32The project number shown in the board’s GitHub URL.
repository: Option<String>owner/name of the repository this source creates an issue in when the item’s own
repositories field does not decide it.
An item naming exactly one repository is created there; a task or a document naming
none or several is created in its parent project’s repository; and a project, or a
task or document with no parent, naming none or several is created here. A board
has no repository of its own and createIssue requires one, so a write without
this is refused naming the field. Reads never need it.
token_env: StringEnvironment variable containing a fine-grained token with Projects and Issues read/write plus Pull requests read-only access for every repository represented on the board.
endpoint: StringGraphQL endpoint. GitHub Enterprise installations may override it.
status_mapping: BTreeMap<String, Option<StatusTargetConfig>>Per-instance mapping from a status category to where it lands on this board.
A category this does not mention keeps its shipped default: backlog to
“Backlog”, todo to “Todo”, queued to “Queued”, in-progress to “In Progress”,
done to closed as
completed, cancelled to closed as not planned, and draft and unknown
disabled. unknown may name one existing board option; every unknown word then
lands on that option and reads back as unknown under its name. It cannot name a
closed state because that reads back as done or cancelled. Unlike local-md,
this source cannot keep each unknown word because it never creates board options.
pacing: PacingConfigHow fast this source writes, and how long it waits out a rate-limit refusal.
Every field keeps its shipped default when it is absent, and the defaults are
GitHub’s own published limits rather than taste. See [Pacing].
Trait Implementations§
Source§impl Clone for GitHubProjectsConfig
impl Clone for GitHubProjectsConfig
Source§fn clone(&self) -> GitHubProjectsConfig
fn clone(&self) -> GitHubProjectsConfig
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for GitHubProjectsConfig
impl Debug for GitHubProjectsConfig
Source§impl Default for GitHubProjectsConfig
impl Default for GitHubProjectsConfig
Source§fn default() -> GitHubProjectsConfig
fn default() -> GitHubProjectsConfig
Source§impl<'de> Deserialize<'de> for GitHubProjectsConfigwhere
GitHubProjectsConfig: Default,
impl<'de> Deserialize<'de> for GitHubProjectsConfigwhere
GitHubProjectsConfig: Default,
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Source§impl JsonSchema for GitHubProjectsConfig
impl JsonSchema for GitHubProjectsConfig
Source§fn schema_id() -> Cow<'static, str>
fn schema_id() -> Cow<'static, str>
Source§fn json_schema(generator: &mut SchemaGenerator) -> Schema
fn json_schema(generator: &mut SchemaGenerator) -> Schema
Source§fn inline_schema() -> bool
fn inline_schema() -> bool
$ref keyword. Read more