Skip to content

Commit

Permalink
expose 'check_urls' in main 'add_contribs' fn for #38
Browse files Browse the repository at this point in the history
  • Loading branch information
mpadge committed May 15, 2024
1 parent 9548702 commit 3e7d167
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 8 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Package: allcontributors
Title: Acknowledge all Contributors to a Project
Version: 0.1.1.004
Version: 0.1.1.005
Authors@R:
person("Mark", "Padgham", , "[email protected]", role = c("aut", "cre"))
Description: Acknowledge all contributors to a project via a single
Expand Down
11 changes: 8 additions & 3 deletions R/add-contributors.R
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,9 @@
#' \item{3} "text" for a single line of text containing comma-separated github
#' user names linked to issue contributions.
#' }
#' @param check_urls If `TRUE` (default), GitHub URLs of all contributors are
#' checked to ensure they are still valid. (This is generally the most
#' time-consuming stage, so set to 'FALSE' if you are sure all URLs are valid.)
#' @param open_issue If `TRUE`, open or edit an issue on github in order to
#' notify all contributors that they've been added to your `README` (see Note).
#' @param force_update If `TRUE`, update the specified files even if
Expand Down Expand Up @@ -78,6 +81,7 @@ add_contributors <- function (repo = ".",
"Issue Contributors"
),
format = "grid",
check_urls = TRUE,
alphabetical = FALSE,
open_issue = FALSE,
force_update = FALSE) {
Expand Down Expand Up @@ -117,6 +121,7 @@ add_contributors <- function (repo = ".",
exclude_issues = exclude_issues,
exclude_not_planned = exclude_not_planned,
alphabetical = alphabetical,
check_urls = check_urls,
quiet = FALSE
)

Expand Down Expand Up @@ -163,9 +168,9 @@ get_org_repo <- function (repo) {
stop ("Repository must have github remote")
}

parsed_remote <- parse_github_remotes(remote)
org <- parsed_remote[["repo_owner"]]
repo <- parsed_remote[["repo_name"]]
parsed_remote <- parse_github_remotes (remote)
org <- parsed_remote [["repo_owner"]]
repo <- parsed_remote [["repo_name"]]

list (
org = org,
Expand Down
3 changes: 0 additions & 3 deletions R/github.R
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,6 @@
#' @param org Github organisation name for repository
#' @param repo Repository within `org` for which contributors are to be
#' extracted
#' @param check_urls If `TRUE` (default), GitHub URLs of all contributors are
#' checked to ensure they are still valid. (This is generally the most
#' time-consuming stage, so set to 'FALSE' if you are sure all URLs are valid.)
#' @param quiet If `FALSE`, display progress information on screen.
#' @inheritParams add_contributors
#'
Expand Down
2 changes: 1 addition & 1 deletion codemeta.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"codeRepository": "https://github.com/ropenscilabs/allcontributors",
"issueTracker": "https://github.com/ropenscilabs/allcontributors/issues",
"license": "https://spdx.org/licenses/GPL-3.0",
"version": "0.1.1.004",
"version": "0.1.1.005",
"programmingLanguage": {
"@type": "ComputerLanguage",
"name": "R",
Expand Down
5 changes: 5 additions & 0 deletions man/add_contributors.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 3e7d167

Please sign in to comment.