| Title: | Client to the 'gitea' API |
|---|---|
| Description: | 'Gitea' is a community managed, lightweight code hosting solution were projects and their respective git repositories can be managed <https://gitea.io>. This package gives an interface to the 'Gitea' API to access and manage repositories, issues and organizations directly in R. |
| Authors: | ixpantia, SRL [aut], Frans van Dunné [cre, aut], Francisco Sácida [aut], Ronny Hernández Mora [aut], Patrick Santamaría Guzmán [ctb] |
| Maintainer: | Frans van Dunné <[email protected]> |
| License: | GPL-3 |
| Version: | 1.0.1 |
| Built: | 2024-06-26 02:29:57 UTC |
| Source: | https://github.com/ixpantia/gitear |
Add a tracked time to an issue
add_tracked_time_issue(base_url, api_key, owner, repo, id_issue, time)add_tracked_time_issue(base_url, api_key, owner, repo, id_issue, time)
base_url |
The base URL for your gitea server (no trailing '/') |
api_key |
The user's API token key for the gitea service |
owner |
The owner of the repository |
repo |
The name of the repository |
id_issue |
Index of the issue to add tracked time to |
time |
The time in seconds to add to the issue |
## Not run: add_tracked_time_issue(base_url = "https://example.gitea.service.com", api_key = "ccaf5c9a22e854856d0c5b1b96c81e851bafb288", owner = "company", repo = "test_repo", id_issue = 2, time = 15) ## End(Not run)## Not run: add_tracked_time_issue(base_url = "https://example.gitea.service.com", api_key = "ccaf5c9a22e854856d0c5b1b96c81e851bafb288", owner = "company", repo = "test_repo", id_issue = 2, time = 15) ## End(Not run)
Add a comment to an issue in a gitea server
create_comment_issue(base_url, api_key, owner, repo, id_issue, body)create_comment_issue(base_url, api_key, owner, repo, id_issue, body)
base_url |
The base URL for your gitea server (no trailing '/') |
api_key |
The user's API token key for the gitea service |
owner |
The owner of the repository |
repo |
The name of the repository |
id_issue |
Index of the issue to create a comment |
body |
The text that is added as a comment to the issue |
## Not run: create_comment_issue(base_url = "https://example.gitea.service.com", api_key = "ccaf5c9a22e854856d0c5b1b96c81e851bafb288", owner = "company", repo = "test_repo", id_issue = 2, body = "my first comment on this issue") ## End(Not run)## Not run: create_comment_issue(base_url = "https://example.gitea.service.com", api_key = "ccaf5c9a22e854856d0c5b1b96c81e851bafb288", owner = "company", repo = "test_repo", id_issue = 2, body = "my first comment on this issue") ## End(Not run)
Create an new issue in a specific repository
create_issue(base_url, api_key, owner, repo, title, body)create_issue(base_url, api_key, owner, repo, title, body)
base_url |
URL prefix for your gitea server (no trailing '/') |
api_key |
The user's API token key for the gitea service |
owner |
The owner of the repository |
repo |
The name of the repository |
title |
The title of the issue |
body |
The body text of the issue |
list with results of the new issue
## Not run: create_issue(base_url = "https://example.gitea.service.com", api_key = "ccaf5c9a22e854856d0c5b1b96c81e851bafb288", owner = "company", repo = "test_repo", title = "Perform clean code task", body = "Perform in an orderly manner and document steps") ## End(Not run)## Not run: create_issue(base_url = "https://example.gitea.service.com", api_key = "ccaf5c9a22e854856d0c5b1b96c81e851bafb288", owner = "company", repo = "test_repo", title = "Perform clean code task", body = "Perform in an orderly manner and document steps") ## End(Not run)
Edit a comment in a specific issue
edit_comment(base_url, api_key, owner, repo, id_comment, body)edit_comment(base_url, api_key, owner, repo, id_comment, body)
base_url |
The base URL for your gitea server (no trailing '/') |
api_key |
The user's API token key for the gitea service |
owner |
The owner of the repository |
repo |
The name of the repository |
id_comment |
Id of the comment to edit |
body |
The text to replace the old comment |
## Not run: edit_comment(base_url = "https://example.gitea.service.com", api_key = "ccaf5c9a22e854856d0c5b1b96c81e851bafb288", owner = "company", repo = "test_repo", id_comment = 612, body = "This is the correction of my comment") ## End(Not run)## Not run: edit_comment(base_url = "https://example.gitea.service.com", api_key = "ccaf5c9a22e854856d0c5b1b96c81e851bafb288", owner = "company", repo = "test_repo", id_comment = 612, body = "This is the correction of my comment") ## End(Not run)
Edit an issue
edit_issue(base_url, api_key, owner, repo, id_issue, title, body, state)edit_issue(base_url, api_key, owner, repo, id_issue, title, body, state)
base_url |
The base URL for your gitea server (no trailing '/') |
api_key |
The user's API token key for the gitea service |
owner |
The owner of the repo |
repo |
The name of the repo |
id_issue |
Index of the issue to edit |
title |
The new issue title text |
body |
The new issue body text |
state |
The issue state |
## Not run: edit_issue(base_url = "https://example.gitea.service.com", api_key = "ccaf5c9a22e854856d0c5b1b96c81e851bafb288", owner = "company", repo = "test_repo", id_issue = 3, title = "My new title for this issue", body = "My new comment starts on this issue", state = "open") ## End(Not run)## Not run: edit_issue(base_url = "https://example.gitea.service.com", api_key = "ccaf5c9a22e854856d0c5b1b96c81e851bafb288", owner = "company", repo = "test_repo", id_issue = 3, title = "My new title for this issue", body = "My new comment starts on this issue", state = "open") ## End(Not run)
Returns the list of organizations for a user with an administrator role
get_admin_organizations(base_url, api_key)get_admin_organizations(base_url, api_key)
base_url |
The base URL for your gitea server (no trailing '/') |
api_key |
The user's API token key for the gitea service |
This function works only in the case that the 'api_key' is associated with a user with administrator role
## Not run: get_admin_organizations(base_url = "https://example.gitea.service.com", api_key = "b6026f861fd41a94c3389d54293de9d04bde6f7c") ## End(Not run)## Not run: get_admin_organizations(base_url = "https://example.gitea.service.com", api_key = "b6026f861fd41a94c3389d54293de9d04bde6f7c") ## End(Not run)
Get information from an organization
get_an_organization(base_url, api_key, org)get_an_organization(base_url, api_key, org)
base_url |
The base URL for your gitea server (no trailing '/') |
api_key |
The user's API token key for the gitea service |
org |
Name of the organization |
## Not run: get_an_organization(base_url = "https://example.gitea.service.com", api_key = "ccaf5c9a22e854856d0c5b1b96c81e851bafb288", org = "company") ## End(Not run)## Not run: get_an_organization(base_url = "https://example.gitea.service.com", api_key = "ccaf5c9a22e854856d0c5b1b96c81e851bafb288", org = "company") ## End(Not run)
Returns branches in a specific repository
get_branches(base_url, api_key, owner, repo)get_branches(base_url, api_key, owner, repo)
base_url |
The base URL for your gitea server (no trailing '/') |
api_key |
The user's API token key for the gitea service |
owner |
The owner of the repository |
repo |
The name of the repository |
## Not run: get_branches(base_url = "https://example.gitea.service.com", api_key = "ccaf5c9a22e854856d0c5b1b96c81e851bafb288", owner = "company", repo = "test_repo") ## End(Not run)## Not run: get_branches(base_url = "https://example.gitea.service.com", api_key = "ccaf5c9a22e854856d0c5b1b96c81e851bafb288", owner = "company", repo = "test_repo") ## End(Not run)
Returns the repository commits of a Gitea application
get_commits(base_url, api_key, owner, repo)get_commits(base_url, api_key, owner, repo)
base_url |
The base URL for your gitea server (no trailing '/') |
api_key |
The user's API token key for the gitea service |
owner |
The owner of the repository |
repo |
The name of the repository |
## Not run: get_commits(base_url = "https://example.gitea.service.com", api_key = "ccaf5c9a22e854856d0c5b1b96c81e851bafb288", owner = "company", repo = "test_repo") ## End(Not run)## Not run: get_commits(base_url = "https://example.gitea.service.com", api_key = "ccaf5c9a22e854856d0c5b1b96c81e851bafb288", owner = "company", repo = "test_repo") ## End(Not run)
Returns forks in a specific repository
get_forks(base_url, api_key, owner, repo)get_forks(base_url, api_key, owner, repo)
base_url |
The base URL for your gitea server (no trailing '/') |
api_key |
The user's API token key for the gitea service |
owner |
The owner of the repository |
repo |
The name of the repository |
## Not run: get_forks(base_url = "https://example.gitea.service.com", api_key = "ccaf5c9a22e854856d0c5b1b96c81e851bafb288", owner = "company", repo = "test_repo") ## End(Not run)## Not run: get_forks(base_url = "https://example.gitea.service.com", api_key = "ccaf5c9a22e854856d0c5b1b96c81e851bafb288", owner = "company", repo = "test_repo") ## End(Not run)
Returns open issues in an specific repository
get_issues(base_url, api_key, owner, repo, full_info = FALSE)get_issues(base_url, api_key, owner, repo, full_info = FALSE)
base_url |
The base URL for your gitea server (no trailing '/') |
api_key |
The user's API token key for the gitea service |
owner |
The owner of the repository |
repo |
The name of the repository |
full_info |
TRUE or FALSE value. If FALSE this will select specific columns from the issues data |
## Not run: get_issues(base_url = "https://example.gitea.service.com", api_key = "ccaf5c9a22e854856d0c5b1b96c81e851bafb288", owner = "company", repo = "test_repo", full_info = FALSE) ## End(Not run)## Not run: get_issues(base_url = "https://example.gitea.service.com", api_key = "ccaf5c9a22e854856d0c5b1b96c81e851bafb288", owner = "company", repo = "test_repo", full_info = FALSE) ## End(Not run)
Returns the issues in closed state of a repository
get_issues_closed_state(base_url, api_key, owner, repo)get_issues_closed_state(base_url, api_key, owner, repo)
base_url |
The base URL for your gitea server (no trailing '/') |
api_key |
The user's API token key for the gitea service |
owner |
The owner of the repository |
repo |
The name of the repository |
## Not run: get_issues_closed_state(base_url = "https://example.gitea.service.com", api_key = "ccaf5c9a22e854856d0c5b1b96c81e851bafb288", owner = "company", repo = "test_repo") ## End(Not run)## Not run: get_issues_closed_state(base_url = "https://example.gitea.service.com", api_key = "ccaf5c9a22e854856d0c5b1b96c81e851bafb288", owner = "company", repo = "test_repo") ## End(Not run)
Returns the issues in open state of a repository
get_issues_open_state(base_url, api_key, owner, repo)get_issues_open_state(base_url, api_key, owner, repo)
base_url |
The base URL for your gitea server (no trailing '/') |
api_key |
The user's API token key for the gitea service |
owner |
The owner of the repository |
repo |
The name of the repository |
## Not run: get_issues_open_state (base_url = "https://example.gitea.service.com", api_key = "ccaf5c9a22e854856d0c5b1b96c81e851bafb288", owner = "company", repo = "test_repo") ## End(Not run)## Not run: get_issues_open_state (base_url = "https://example.gitea.service.com", api_key = "ccaf5c9a22e854856d0c5b1b96c81e851bafb288", owner = "company", repo = "test_repo") ## End(Not run)
Returns an issue's labels
get_label_issue(base_url, api_key, owner, repo, id_issue)get_label_issue(base_url, api_key, owner, repo, id_issue)
base_url |
The base URL for your gitea server (no trailing '/') |
api_key |
The user's API token key for the gitea service |
owner |
The owner of the repository |
repo |
The name of the repository |
id_issue |
Index of the issue |
## Not run: get_label_issue(base_url = "https://example.gitea.service.com", api_key = "ccaf5c9a22e854856d0c5b1b96c81e851bafb288", owner = "company", repo = "test_repo", id_issue = 3) ## End(Not run)## Not run: get_label_issue(base_url = "https://example.gitea.service.com", api_key = "ccaf5c9a22e854856d0c5b1b96c81e851bafb288", owner = "company", repo = "test_repo", id_issue = 3) ## End(Not run)
Returns a list of all comments on an issue
get_list_comments_issue(base_url, api_key, owner, repo, id_issue)get_list_comments_issue(base_url, api_key, owner, repo, id_issue)
base_url |
The base URL for your gitea server (no trailing '/') |
api_key |
The user's API token key for the gitea service |
owner |
The owner of the repository |
repo |
The name of the repository |
id_issue |
Index of the issue to get comments |
## Not run: get_list_comments_issue(base_url = "https://example.gitea.service.com", api_key = "ccaf5c9a22e854856d0c5b1b96c81e851bafb288", owner = "company", repo = "test_repo", id_issue = 3) ## End(Not run)## Not run: get_list_comments_issue(base_url = "https://example.gitea.service.com", api_key = "ccaf5c9a22e854856d0c5b1b96c81e851bafb288", owner = "company", repo = "test_repo", id_issue = 3) ## End(Not run)
Returns a list of all comments in a repository
get_list_comments_repository(base_url, api_key, owner, repo)get_list_comments_repository(base_url, api_key, owner, repo)
base_url |
The base URL for your gitea server (no trailing '/') |
api_key |
The user's API token key for the gitea service |
owner |
The owner of the repository |
repo |
The name of the repository |
## Not run: get_list_comments_repository(base_url = "https://example.gitea.service.com", api_key = "ccaf5c9a22e854856d0c5b1b96c81e851bafb288", owner = "company", repo = "test_repo") ## End(Not run)## Not run: get_list_comments_repository(base_url = "https://example.gitea.service.com", api_key = "ccaf5c9a22e854856d0c5b1b96c81e851bafb288", owner = "company", repo = "test_repo") ## End(Not run)
List an organization's members
get_list_org_members(base_url, api_key, org)get_list_org_members(base_url, api_key, org)
base_url |
The base URL for your gitea server (no trailing '/') |
api_key |
The user's API token key for the gitea service |
org |
Name of the organization |
## Not run: get_list_org_members(base_url = "https://example.gitea.service.com", api_key = "ccaf5c9a22e854856d0c5b1b96c81e851bafb288", org = "company") ## End(Not run)## Not run: get_list_org_members(base_url = "https://example.gitea.service.com", api_key = "ccaf5c9a22e854856d0c5b1b96c81e851bafb288", org = "company") ## End(Not run)
Get organization's teams
get_list_org_teams(base_url, api_key, org)get_list_org_teams(base_url, api_key, org)
base_url |
The base URL for your gitea server (no trailing '/') |
api_key |
The user's API token key for the gitea service |
org |
Name of the organization |
## Not run: get_list_org_teams(base_url = "https://example.gitea.service.com", api_key = "ccaf5c9a22e854856d0c5b1b96c81e851bafb288", org = "company") ## End(Not run)## Not run: get_list_org_teams(base_url = "https://example.gitea.service.com", api_key = "ccaf5c9a22e854856d0c5b1b96c81e851bafb288", org = "company") ## End(Not run)
Get a list of an organization's repositories
get_list_repos_org(base_url, api_key, org)get_list_repos_org(base_url, api_key, org)
base_url |
The base URL for your gitea server (no trailing '/') |
api_key |
The user's API token key for the gitea service |
org |
Name of the organization |
## Not run: get_list_repos_org(base_url = "https://example.gitea.service.com", api_key = "ccaf5c9a22e854856d0c5b1b96c81e851bafb288", org = "company") ## End(Not run)## Not run: get_list_repos_org(base_url = "https://example.gitea.service.com", api_key = "ccaf5c9a22e854856d0c5b1b96c81e851bafb288", org = "company") ## End(Not run)
User list for a gitea server
get_list_users(base_url, api_key)get_list_users(base_url, api_key)
base_url |
The base URL for your gitea server (no trailing '/') |
api_key |
The user's API token key for the gitea service |
## Not run: get_list_users(base_url = "https://example.gitea.service.com", api_key = "ccaf5c9a22e854856d0c5b1b96c81e851bafb288") ## End(Not run)## Not run: get_list_users(base_url = "https://example.gitea.service.com", api_key = "ccaf5c9a22e854856d0c5b1b96c81e851bafb288") ## End(Not run)
Returns open milestones in a specific repository
get_milestones(base_url, api_key, owner, repo)get_milestones(base_url, api_key, owner, repo)
base_url |
The base URL for your gitea server (no trailing '/') |
api_key |
The user's API token key for the gitea service |
owner |
The owner of the repository |
repo |
The name of the repository |
## Not run: get_milestones(base_url = "https://example.gitea.service.com", api_key = "ccaf5c9a22e854856d0c5b1b96c81e851bafb288", owner = "company", repo = "test_repo") ## End(Not run)## Not run: get_milestones(base_url = "https://example.gitea.service.com", api_key = "ccaf5c9a22e854856d0c5b1b96c81e851bafb288", owner = "company", repo = "test_repo") ## End(Not run)
Get a hook information of a organizations
get_org_hook(base_url, api_key, org, id_hook)get_org_hook(base_url, api_key, org, id_hook)
base_url |
The base URL for your gitea server (no trailing '/') |
api_key |
The user's API token key for the gitea service |
org |
Name of the organization |
id_hook |
Id of the hook to get information |
## Not run: get_org_hook(base_url = "https://example.gitea.service.com", api_key = "ccaf5c9a22e854856d0c5b1b96c81e851bafb288", org = "company", id_hook = 2) ## End(Not run)## Not run: get_org_hook(base_url = "https://example.gitea.service.com", api_key = "ccaf5c9a22e854856d0c5b1b96c81e851bafb288", org = "company", id_hook = 2) ## End(Not run)
Returns a list of organization's webhooks
get_org_list_hooks(base_url, api_key, org)get_org_list_hooks(base_url, api_key, org)
base_url |
The base URL for your gitea server (no trailing '/') |
api_key |
The user's API token key for the gitea service |
org |
Name of the organization |
## Not run: get_org_list_hooks(base_url = "https://example.gitea.service.com", api_key = "ccaf5c9a22e854856d0c5b1b96c81e851bafb288", org = "company") ## End(Not run)## Not run: get_org_list_hooks(base_url = "https://example.gitea.service.com", api_key = "ccaf5c9a22e854856d0c5b1b96c81e851bafb288", org = "company") ## End(Not run)
Returns list the current user's organizations
get_organizations(base_url, api_key)get_organizations(base_url, api_key)
base_url |
The base URL for your gitea server (no trailing '/') |
api_key |
The user's API token key for the gitea service |
## Not run: get_organizations(base_url = "https://example.gitea.service.com", api_key = "ccaf5c9a22e854856d0c5b1b96c81e851bafb288") ## End(Not run)## Not run: get_organizations(base_url = "https://example.gitea.service.com", api_key = "ccaf5c9a22e854856d0c5b1b96c81e851bafb288") ## End(Not run)
Returns open and closed pull requests in a specific repository
get_pull_requests(base_url, api_key, owner, repo)get_pull_requests(base_url, api_key, owner, repo)
base_url |
The base URL for your gitea server (no trailing '/') |
api_key |
The user's API token key for the gitea service |
owner |
The owner of the repository |
repo |
The name of the repository |
## Not run: get_pull_requests(base_url = "https://example.gitea.service.com", api_key = "ccaf5c9a22e854856d0c5b1b96c81e851bafb288", owner = "company", repo = "test_repo") ## End(Not run)## Not run: get_pull_requests(base_url = "https://example.gitea.service.com", api_key = "ccaf5c9a22e854856d0c5b1b96c81e851bafb288", owner = "company", repo = "test_repo") ## End(Not run)
Returns releasess in a specific repository
get_releases(base_url, api_key, owner, repo)get_releases(base_url, api_key, owner, repo)
base_url |
The base URL for your gitea server (no trailing '/') |
api_key |
The user's API token key for the gitea service |
owner |
The owner of the repository |
repo |
The name of the repository |
## Not run: get_releases(base_url = "https://example.gitea.service.com", api_key = "ccaf5c9a22e854856d0c5b1b96c81e851bafb288", owner = "company", repo = "test_repo") ## End(Not run)## Not run: get_releases(base_url = "https://example.gitea.service.com", api_key = "ccaf5c9a22e854856d0c5b1b96c81e851bafb288", owner = "company", repo = "test_repo") ## End(Not run)
Returns the repositories of the Gitea application
get_repositories(base_url, api_key)get_repositories(base_url, api_key)
base_url |
The base URL for your gitea server (no trailing '/') |
api_key |
The user's API token key for the gitea service |
## Not run: get_repositories(base_url = "https://example.gitea.service.com", api_key = "ccaf5c9a22e854856d0c5b1b96c81e851bafb288") ## End(Not run)## Not run: get_repositories(base_url = "https://example.gitea.service.com", api_key = "ccaf5c9a22e854856d0c5b1b96c81e851bafb288") ## End(Not run)
Returns a data frame of an issue's tracked times
get_times_issue(base_url, api_key, owner, repo, id_issue)get_times_issue(base_url, api_key, owner, repo, id_issue)
base_url |
The base URL for your gitea server (no trailing '/') |
api_key |
The user's API token key for the gitea service |
owner |
The owner of the repository |
repo |
The name of the repository |
id_issue |
Index of the issue |
## Not run: get_times_issue(base_url = "https://example.gitea.service.com", api_key = "ccaf5c9a22e854856d0c5b1b96c81e851bafb288", owner = "company", repo = "test_repo", id_issue = 3) ## End(Not run)## Not run: get_times_issue(base_url = "https://example.gitea.service.com", api_key = "ccaf5c9a22e854856d0c5b1b96c81e851bafb288", owner = "company", repo = "test_repo", id_issue = 3) ## End(Not run)
Returns the version of the Gitea application
get_version(base_url, api_key)get_version(base_url, api_key)
base_url |
The base URL for your gitea server (no trailing '/') |
api_key |
The user's API token key for the gitea service |
## Not run: get_version(base_url = "https://example.gitea.service.com", api_key = "ccaf5c9a22e854856d0c5b1b96c81e851bafb288") ## End(Not run)## Not run: get_version(base_url = "https://example.gitea.service.com", api_key = "ccaf5c9a22e854856d0c5b1b96c81e851bafb288") ## End(Not run)
gitear package'Gitea' is a community managed, lightweight code hosting solution were projects and their respective git repositories can be managed access and manage repositories, issues and organizations directly in R.