post_plan: Post plan (milestones + issues) to GitHub repository

View source: R/plan-todo.R

post_planR Documentation

Post plan (milestones + issues) to GitHub repository

Description

Post custom plans (i.e. create milestones and issues) based on yaml read in by read_plan. Please see the "Building Custom Plans" vignette for details.

Usage

post_plan(ref, plan, distinct = TRUE)

Arguments

ref

Repository reference (list) created by create_repo_ref()

plan

Plan list as read with read_plan()

distinct

Logical value to denote whether issues with the same title as a current open issue should be allowed. Passed to get_issues()

Value

Dataframe with numbers (identifiers) of posted milestones and issues and issue title

See Also

Other plans and todos: post_todo(), read_plan(), read_todo(), report_plan(), report_todo(), template_yaml()

Examples

## Not run: 
# This example uses example file included in pkg
# You should be able to run example as-is after creating your own repo reference
file_path <- system.file("extdata", "plan.yml", package = "projmgr", mustWork = TRUE)
my_plan <- read_plan(file_path)
post_plan(ref, my_plan)

## End(Not run)

emilyriederer/projmgr documentation built on Jan. 26, 2024, 3:09 a.m.