Feature/gitlab 02 #109

ntrlshrp · 2020-01-09T21:00:36Z

As suggested by @nevrome , I've created a PR relevant to issue #91 . Thanks.

Created skeleton function that mirrors usethis::use_github(). Created template CI/CD file .gitlab-ci.yml that uses Dockerfile to do the work. Added hello.R so code coverage can be tested.

Enabled push to registry, correct rocker and r_version, code coverage report

If this is not done, my Dockerfile fails to render `paper.html`

Previously this printed "" to the screen

Setting `branch.master.remote` to "origin" is useful to not print your auth_token to the screen each time you push

No need for extra steps

The readme uses default values (i.e., "github") at first but then overrides those with "gitlab"

It also tells user what to change to take further advantage of .gitlab-ci.yml

Variables let you turn jobs on and off. Documentation helps user learn more quickly how to use and extend `.gitlab-ci.yml`.

This enables devtools::check() to succeed

This allows README and CONTRIBUTING to conform to different remote git services such as github, gitlab, etc.

In order for `gitRemoteService` to be properly passed to README and CONTRIBUTING templates, I had to change some of the github specific functions. I also needed to recapture information that had been updated after create_compendium() by use_gitlab().

Allowed "github" and "gitlab" to return TRUE on some functions. Changed `<USERNAME>` and `<REPO>` github_dummy values to `USERNAME` and `REPO`, otherwise the .gitlab-ci.yml fails with: `$ docker cp `dl`:<REPO>/analysis/paper/. $CI_PROJECT_DIR/public /bin/sh: eval: line 91: can't open REPO: no such file`

Added hello() as example of hello() in order to avoid a warning on devtools::document()

I had accidentally copied over this file with hard-coded rocker/verse:3.6.1 and have now rectified that.

This period helped me avoid this error when running devtools::check() within Docker container, `Malformed Description field: should contain one or more complete sentences.`

code-coverage-report job was running at the wrong time because I had copied over the variable. Also clarified comments.

Used `usethis::use_github()` documentation as template to make helpfile more substantive. git user.name is a "full name" while gitlab.username is the GitLab Login name. This piece also has an if-then to allow automated use of the function in a CI/CD.

If the project already has an `origin` remote associated with the local repo, it stops and warns user rather than trying to overwrite it. Rather than ask the user to consent to overwriting CONDUCT, CONTRIBUTING, and README, now we rename those files. This also facilitates automated use of function. Changed 'yes' to "yes" in 107/115. Unfortunately, lots of whitespace changes. :(

Merge remote-tracking branch 'upstream/master' into feature/gitlab-02 # Conflicts: # R/core_use_analysis.R # R/core_use_compendium.R

devtools::check() creates a note when you use pkg:::function(). This replaces `usethis:::uses_git()` with its exported functions equivalent.

rrtools Dockerfile template currently uses `devtools::install(dep=TRUE)`. The gitlab-ci.yml now consistently uses the same.

When rrtools default was to produce `paper.html`, this could become `index.html` for easy publishing. rrtools default is now `paper.docx`. Will need to check if language in helpfile and README point users to published file or an error.

…1; added function helpfile to match `usethis::use_github()` This `.gitlab-ci.yml` programatically tests use case (1) for `use_gitlab()`: user creates new compendium, immediately runs `rrtools::use_gitlab()`. Others should be able to test this case programatically (see below) and manually. This fixed issue %1 where gitlab username does not equal the value returned by `git config user.name`--as a "full name", this will rarely equal the user's GitLab LOGIN which is what is needed. See ?rrtools::use_gitlab for the helpfile. Programatically, to make this work, https://gitlab.com/ntrlshrp/rrtools-mirror mirrors the GitHub repo forked from `benmarwick/rrtools`. When the `.gitlab-ci.yml` in this commit is run on GitLab, the `make-new-rrtools-compendium` job installs an rrtools branch from GitHub that exports the `use_gitlab()` function, then creates a new compendium, and immediately runs `rrtools::use_gitlab()`. This pushes the local repo to a DIFFERENT GitLab remote repo, `newRRtoolsCompendium` (the user must manually delete `newRRtoolsCompendium` each time they want the `make-new-rrtools-compendium` job to succeed). Then the job makes a commit that includes the now installed .gitlab-ci.yml template and pushes to `newRRtoolsCompendium`, this triggers GitLab CI/CD that creates a reproducible paper using the Dockerfile template. The `.gitlab-ci.yml` only works if the user has added a variable to their GitLab rrtools (mirror) repo named `RRTOOLS_TOKEN`, the value of which is a GitLab personal access token with `api` scope. See ?rrtools::use_gitlab for help setting this up.

…tools now renders .docx

nevrome

It's really difficult to test all of this - especially when you consider the possible interactions of different web services - but I think the general workflow is fine.

Maybe somebody with much more gitlab experience could try it as well? Maybe @dakni?

nevrome · 2020-01-11T14:05:07Z

.gitlab-ci.yml

@@ -0,0 +1,96 @@
+image: docker:stable


I'm not sure if I understand why you added this .gitlab-ci.yml file - despite the explanation in #91 (comment).

I mean: This would be excellent to have if the rrtools package was hosted on gitlab. Then we would have a nice testing infrastructure. But it's currently not. So our .travis.yml is fine, this file will do nothing and we would have to maintain it without actually using it.

Or am I missing something?

nevrome · 2020-01-11T14:16:02Z

R/core_use_gitlab.R

+                 pkg = pkg,
+                 out_path = "")
+    # replace the README.md
+    file.rename("CONDUCT.md", "CONDUCT.md.bak")


As already stated: Here should be a check for existence. I also think a console message that mentions this step would be nice.

nevrome · 2020-01-11T14:19:18Z

R/helpers_github.R

-  nzchar(Sys.getenv("CI"))
-}
+# from https://github.com/hadley/devtools/blob/master/R/git.R
+uses_github <- function(path = ".") {


The function names in this file are technically not correct any more and I don't know if all of these functions work interchangeably for github and gitlab. Do they, @ntrlshrp?

benmarwick · 2024-02-05T18:36:46Z

Closing this due to lack of recent activity.

ntrlshrp added 30 commits September 9, 2019 13:42

Added use_gitlab()

8a19cd1

Created skeleton function that mirrors usethis::use_github(). Created template CI/CD file .gitlab-ci.yml that uses Dockerfile to do the work. Added hello.R so code coverage can be tested.

Updated gitlab-ci.yml template

9b5eda7

Enabled push to registry, correct rocker and r_version, code coverage report

Added devtools, git2r, and here to Imports

254df3f

If this is not done, my Dockerfile fails to render `paper.html`

Fixed ui_todo message

f1fedd9

Previously this printed "" to the screen

use_gitlab() can send repo to gitlab.com

3553c2b

Setting `branch.master.remote` to "origin" is useful to not print your auth_token to the screen each time you push

use_gitlab() automatically uses Dockerfile template

3812204

No need for extra steps

use_gitlab() recreates README

c73701a

The readme uses default values (i.e., "github") at first but then overrides those with "gitlab"

use_gitlab() briefly informs user of its purpose

fd57835

It also tells user what to change to take further advantage of .gitlab-ci.yml

Added variables and documentation to .gitlab-ci.yml

d36d4e6

Variables let you turn jobs on and off. Documentation helps user learn more quickly how to use and extend `.gitlab-ci.yml`.

Added documentation to hello()

f4b86c8

This enables devtools::check() to succeed

Inserted gitRemoteService variable

14528e3

This allows README and CONTRIBUTING to conform to different remote git services such as github, gitlab, etc.

Added @examples

2045920

Added hello() as example of hello() in order to avoid a warning on devtools::document()

Fixed .gitlab-ci.yml template

44050af

I had accidentally copied over this file with hard-coded rocker/verse:3.6.1 and have now rectified that.

Added period to use_compendium() template

5334b47

This period helped me avoid this error when running devtools::check() within Docker container, `Malformed Description field: should contain one or more complete sentences.`

Fixed .gitlab-ci.yml template

e19713d

code-coverage-report job was running at the wrong time because I had copied over the variable. Also clarified comments.

Consistently user USERname and REPOname

5aad714

Added error if auth_token not set

8b394ad

Removed stray "Title" in function documentation

94041e2

Removed stray "Title" in function documentation 2

47e9695

Merged in upstream/master

fe16a74

Merge remote-tracking branch 'upstream/master' into feature/gitlab-02 # Conflicts: # R/core_use_analysis.R # R/core_use_compendium.R

Replaced internal function with exported functions

b97b63d

devtools::check() creates a note when you use pkg:::function(). This replaces `usethis:::uses_git()` with its exported functions equivalent.

Replaced remotes::install_deps() with devtools::install()

0aa0d79

rrtools Dockerfile template currently uses `devtools::install(dep=TRUE)`. The gitlab-ci.yml now consistently uses the same.

Removed .html specific cp command

7b2f863

When rrtools default was to produce `paper.html`, this could become `index.html` for easy publishing. rrtools default is now `paper.docx`. Will need to check if language in helpfile and README point users to published file or an error.

Added ?rrtools helpfile

ca9147a

Added missing () to usethis::proj_get

636aa25

Enabled docker: dind in .gitlab-ci.yml; removed copy of .html as rr…

efa3e20

…tools now renders .docx

ntrlshrp mentioned this pull request Jan 9, 2020

Currently lacks support for GitLab repositories #91

Closed

nevrome reviewed Jan 11, 2020

View reviewed changes

nevrome mentioned this pull request Jan 31, 2020

Discussion: use_github() #110

Closed

nevrome mentioned this pull request Apr 5, 2020

Gitlab 03 #121

Merged

nevrome mentioned this pull request Jul 3, 2020

Add use_github_action #132

Open

benmarwick closed this Feb 5, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature/gitlab 02 #109

Feature/gitlab 02 #109

ntrlshrp commented Jan 9, 2020

nevrome left a comment

nevrome Jan 11, 2020 •

edited

Loading

nevrome Jan 11, 2020

nevrome Jan 11, 2020

benmarwick commented Feb 5, 2024

Feature/gitlab 02 #109

Feature/gitlab 02 #109

Conversation

ntrlshrp commented Jan 9, 2020

nevrome left a comment

Choose a reason for hiding this comment

nevrome Jan 11, 2020 • edited Loading

Choose a reason for hiding this comment

nevrome Jan 11, 2020

Choose a reason for hiding this comment

nevrome Jan 11, 2020

Choose a reason for hiding this comment

benmarwick commented Feb 5, 2024

nevrome Jan 11, 2020 •

edited

Loading