R/curriculum_feed.R

In carpentries/feeds.carpentries.org: Generation of the files for feeds.carpentries.org

### data feed for the repository information for the official lessons.
###
### Currently the curriculum is hard-coded, ideally we'd want this information
### to come from somewhere else.
###
### This script has a side effect to ensure that all repos with the 'lesson'
### github topic have the appropriate other topics (at least for life cycle and
### human languages).

# NOTE:
#
# If you find yourself here wondering why the lesson feed has failed yet again,
# remember that this works on GitHub topic tags, which are not part of the git
# repository, but specific to GitHub. 
#
# --- Zhian (2023-12-14)

source("R/utils.R")

# ZNK 2023-12-14: 
# Adding the "template" tag here so that we can exclude the templates from our
# official lesson count. This _is_ a new tag and it's not one that's present in
# the workbench yet. For now, it will allow the feeds to work.
LIFE_CYCLE_TAGS <- c("pre-alpha", "alpha", "beta", "stable", "on-hold", 
  "template")
HUMAN_LANGUAGE <- c("english", "spanish")

GITHUB_ORGS <- c(
  "carpentries",
  "datacarpentry",
  "swcarpentry",
  "librarycarpentry"
)

##' @param path the path (including file name) where the lesson feed need to be
##'   saved.k
make_lessons_feed <- function(path) {

  purrr::map_df(
    GITHUB_ORGS,
    get_org_topics
  )  %>%
    dplyr::filter(
      !private,
      purrr::map_lgl(github_topics, ~ "lesson" %in% .)
    ) %>%
    extract_tag(
      life_cycle_tag,
      LIFE_CYCLE_TAGS,
      approach = "include",
      allow_multiple = FALSE,
      allow_empty = FALSE
    ) %>%
    extract_tag(
      human_language,
      HUMAN_LANGUAGE,
      approach = "include",
      allow_multiple = FALSE,
      allow_empty = FALSE
    ) %>%
    dplyr::select(
      carpentries_org,
      repo,
      repo_url,
      description,
      rendered_site,
      life_cycle = life_cycle_tag,
      human_language,
      github_topics
    ) %>%
    dplyr::mutate(
      human_language = unlist(human_language),
      life_cycle = unlist(life_cycle)
    ) %>%
    jsonlite::write_json(path)

}


make_lessons_feed("_data/lessons.json")