gitlabr
gitlabr copied to clipboard
Mettre en conformité les GitHub Actions du package
Attention: CI is very special for {gitlabr} because of environment variables
- [ ] Mettre les ORCID des dev dans le fichier DESCRIPTION, partie
Authors - [ ] Mettre ThinkR en rôle
cphdans le fichier DESCRIPTION, partieAuthors:person("ThinkR", role = "cph") - [ ] Ajouter le COC
usethis::use_code_of_conduct() - [ ] Mettre en place le CI et les badges sur la page du README (check, codecov)
# Doc
usethis::use_github_action_check_standard()
usethis::use_github_action("pkgdown")
usethis::use_github_action("test-coverage")
usethis::use_coverage()
usethis::use_build_ignore("_pkgdown.yml")
- [ ] Ajouter le badges du CRAN avec version et celui avec downloads
- [ ] Dessiner un hex
- [ ] Ajouter l'hex dans "man/figures/logo.png" de telle sorte qu'il soit utilisé dans le pkgdown
- [ ] Ajouter l'hex dans le Readme
- e.g.
# fusen <img src="man/figures/logo.png" align="right" alt="" width="120" />
- e.g.
- [ ] Ajouter le template ThinkR et la bonne url pour le pkgdown
- Créer un fichier '_pkgdown.yml' à la racine du projet avec ce code:
template:
package: thinkrtemplate
# Changer l'url pour celle du pkgdown
url: https://thinkr-open.github.io/fusen/
development:
mode: auto
- [ ] Ajouter
Config/Needs/website: ThinkR-open/thinkrtemplatedans le fichier DESCRIPTION de telle sorte que l'Action pkgdown puisse fonctionner correctement (nécessite version récente -2022- de GitHub Action pour pkgdown)- Relancer
usethis::use_github_action("pkgdown")au besoin en acceptant le changement complet
- Relancer
- [ ] Afficher le lien site pkgdown dans la partie "About" de la page GitHub
- [ ] Afficher l'URL du pkgdown + url du GitHub dans la partie
URLdu fichier description- e.g. pour {fusen}: https://github.com/ThinkR-open/fusen/blob/main/DESCRIPTION
URL: https://thinkr-open.github.io/fusen/,
https://github.com/Thinkr-open/fusen
- Ajouter le lien pour les bug report dans le fichier DESCRIPTION
- e.g.
BugReports: https://github.com/ThinkR-open/golem/issues
- e.g.
- [ ] Vérifier que ça passe les checks sur GitHub Actions
- [ ] Github topics: r-package, course-material, showcase https://github.com/orgs/ThinkR-open/topics
- [ ] Doc générale du package (
usethis::use_package_doc()) - [ ] S'assurer qu'il y a un fichier NEWS.md
- [ ] S'assurer qu'il y a des Release + tags git en lien avec les versions du NEWS.md