Skip to content
Snippets Groups Projects
Commit bf7075a3 authored by MORIN Edouard's avatar MORIN Edouard
Browse files

Merge branch 'dev' into 'main'

Dev to main

See merge request dreal-pdl/csd/acter/spred!2
parents 9bc345f8 d3c5f76d
Branches
Tags
1 merge request!2Dev to main
Pipeline #521127 passed
......@@ -22,7 +22,7 @@ build_waitingpage <- function(waitingpage,lang="fr"){
}
#' Deploy all content exept that listed to FTP folder
#' Deploy all content except that listed in `exept` to FTP
#' @description
#' deploys in an FTP "dirto" directory all the files and subfolders of "dirfrom",
#' except those listed. This operation first deletes unlisted contents
......
#' Test FTP folder access
#' FTP folder access test
#' @description
#' checks if the path from the ftp root exists.
#' also allows you to check if the ftp connection is working
......
......@@ -32,7 +32,7 @@ ftp_dir_simple <- function(con, url, path = "/") {
return(as.data.frame(res))
}
#' List content FTP folder recursively
#' Reviewing the contents of the FTP folder recursively
#' @description
#' reviews an entire ftp folder and its subfolders recursively
#'
......
#' Remove all content exept that listed to FTP folder
#' Delete all content except the one listed in `exept` to FTP
#' @description
#' deletes from a "dirto" FTP directory all files and subfolders, except those listed.
#' if a subdirectory is not emptied, it is not deleted.
......
#' Rewrite all content exept that listed to FTP folder
#' Rewrite all content except the one listed in `exept` to the FTP folder
#' @description
#' writes to an FTP directory "dirto" all files and subfolders of "dirfrom",
#' except those listed. This operation overwrites files with the same name.
......
#' List content local folder recursively
#' Reviewing local folder contents recursively
#' @description
#' reviews an entire local folder and its subfolders recursively
#'
......
......@@ -25,7 +25,9 @@ sur des servers distants, via les protocoles ftp, sftp, samba, scp et ssh git.
This package aims to allow you to easily deploy your content to remote servers,
with ftp, sftp, smb, scp and ssh git protocols.
ite web de présentation du package : [https://dreal-pdl.gitlab-pages.din.developpement-durable.gouv.fr/csd/acter/spred/index.html](https://dreal-pdl.gitlab-pages.din.developpement-durable.gouv.fr/csd/acter/spred/index.html)
*spred means "severals protocols with reduced expressions for deployment"*
Site web de présentation du package : [https://dreal-pdl.gitlab-pages.din.developpement-durable.gouv.fr/csd/acter/spred/index.html](https://dreal-pdl.gitlab-pages.din.developpement-durable.gouv.fr/csd/acter/spred/index.html)
## Installation
......@@ -34,9 +36,10 @@ remotes::install_gitlab('dreal-pdl/csd/acter/spred', host = "gitlab-forge.din.de
```
## Example
## Examples
Ci-dessous un exemple d'usage de `spred` pour un déploiement FTP.
Below is an example of using `spred` for an FTP deployment.
```{r example}
## basic example code to FTP deploy
......@@ -64,6 +67,9 @@ Actuelement le package se limite à la prise en charge du protole FTP.
V0.0.1
Note : aucun test unitaire n'est effectué. Projet en *développement* !
Note : aucun test unitaire n'est effectué.
Projet en *développement* !
Project in *development*!
......@@ -15,7 +15,10 @@ scp et ssh git.
This package aims to allow you to easily deploy your content to remote
servers, with ftp, sftp, smb, scp and ssh git protocols.
ite web de présentation du package :
*spred means “severals protocols with reduced expressions for
deployment”*
Site web de présentation du package :
<https://dreal-pdl.gitlab-pages.din.developpement-durable.gouv.fr/csd/acter/spred/index.html>
## Installation
......@@ -24,9 +27,10 @@ ite web de présentation du package :
remotes::install_gitlab('dreal-pdl/csd/acter/spred', host = "gitlab-forge.din.developpement-durable.gouv.fr")
```
## Example
## Examples
Ci-dessous un exemple d’usage de `spred` pour un déploiement FTP.
Ci-dessous un exemple d’usage de `spred` pour un déploiement FTP. Below
is an example of using `spred` for an FTP deployment.
``` r
## basic example code to FTP deploy
......@@ -61,3 +65,5 @@ Actuelement le package se limite à la prise en charge du protole FTP.
V0.0.1
Note : aucun test unitaire n’est effectué. Projet en *développement* !
Project in *development*!
......@@ -25,7 +25,7 @@ navbar:
reference:
- title: "Fonctions FTP"
desc: "Les fonctions pour vos déploiements FTP."
desc: "Les fonctions pour vos déploiements FTP.\nFunctions for your FTP deployments."
contents:
- ftp_deploy
- ftp_dir_exist
......@@ -34,7 +34,7 @@ reference:
- ftp_write_all_exept
- ftp_rm_all_exept
- title: "Fonctions de base"
desc: "Toutes les autres fonctions pour vous aider à déployer."
desc: "Toutes les autres fonctions pour vous aider à déployer.\nAll other functions to help you deploy."
contents:
- local_dir_exist
- local_dir_rec
......@@ -2,7 +2,7 @@
% Please edit documentation in R/ftp_deploy.R
\name{ftp_deploy}
\alias{ftp_deploy}
\title{Deploy all content exept that listed to FTP folder}
\title{Deploy all content except that listed in \code{exept} to FTP}
\usage{
ftp_deploy(
dirfrom,
......
......@@ -2,7 +2,7 @@
% Please edit documentation in R/ftp_dir_exist.R
\name{ftp_dir_exist}
\alias{ftp_dir_exist}
\title{Test FTP folder access}
\title{FTP folder access test}
\usage{
ftp_dir_exist(con, url, path = "/")
}
......
......@@ -2,7 +2,7 @@
% Please edit documentation in R/ftp_dir_rec.R
\name{ftp_dir_rec}
\alias{ftp_dir_rec}
\title{List content FTP folder recursively}
\title{Reviewing the contents of the FTP folder recursively}
\usage{
ftp_dir_rec(con, url, path = "/", exept = list())
}
......
......@@ -2,7 +2,7 @@
% Please edit documentation in R/ftp_rm_all_exept.R
\name{ftp_rm_all_exept}
\alias{ftp_rm_all_exept}
\title{Remove all content exept that listed to FTP folder}
\title{Delete all content except the one listed in \code{exept} to FTP}
\usage{
ftp_rm_all_exept(
dirto,
......
......@@ -2,7 +2,7 @@
% Please edit documentation in R/ftp_write_all_exept.R
\name{ftp_write_all_exept}
\alias{ftp_write_all_exept}
\title{Rewrite all content exept that listed to FTP folder}
\title{Rewrite all content except the one listed in \code{exept} to the FTP folder}
\usage{
ftp_write_all_exept(dirfrom, dirto, con, url, exept = list(), verbose = FALSE)
}
......
......@@ -2,7 +2,7 @@
% Please edit documentation in R/local_dir_rec.R
\name{local_dir_rec}
\alias{local_dir_rec}
\title{List content local folder recursively}
\title{Reviewing local folder contents recursively}
\usage{
local_dir_rec(path = getwd(), exept = list(), only = list())
}
......
......@@ -6,6 +6,8 @@
\alias{spred-package}
\title{spred: Spread Your Wings And Your Apps Easily With Spred}
\description{
\if{html}{\figure{logo.png}{options: style='float: right' alt='logo' width='120'}}
Ce package vous permet de deployer facilement vos contenus sur des servers distants, via les protocoles ftp, sftp, samba, scp et ssh git. This package allows you to easily deploy your content to remote servers, with ftp, sftp, smb, scp and ssh git protocols.
}
\seealso{
......
......@@ -23,13 +23,13 @@ Cette fonction vous facilite votre déploiement car elle est tout en un.
- Elle déploie l'ensemble du contenu de votre dossier de départ, exepté les sous-dossiers et fichiers listés dans `exept`.
- Dans le cas de déploements longs (par exemple avec des .Rda volumineux), vous pouvez mettre en place une page d'attente pour vos déploiement en production. Ainsi vos utilisateurs seront avertis qu'une opération de maintenance est en cours.
- Dans le cas de déploiements longs (par exemple avec des .Rda volumineux), vous pouvez mettre en place une page d'attente pour votre déploiement en production. Ainsi vos utilisateurs seront avertis qu'une opération de maintenance est en cours.
Points de vigilance :
- si vos droits d'écriture sont insuffisant sur le dossier FTP, vous prenez le risque d'effacer partiellement le dépôt avant que la fonction stoppe. Il est donc recommander de faire votre premier déploiement sur un dossier vide (pas besoin de le créer, il se créera automatiquement) afin que les droits de modification de tous les fichiers soient accordés à votre utilisateur FTP.
- si vos droits d'écriture sont insuffisants sur le dossier FTP, vous prenez le risque d'effacer partiellement le dépôt avant que la fonction ne stoppe. Il est donc recommandé de faire votre premier déploiement sur un dossier vide (pas besoin de le créer, il se créera automatiquement) afin que les droits de modification de tous les fichiers soient accordés à votre utilisateur FTP.
- les fonctions de spred s'applique également aux dossiers cachés. Par défaut, la fonction ftp_deploy_exept, exclut les dossiers ".git/" et ".Rproj.user/". Si vous souhaitez ajouter d'autre exclusion, n'oubliez pas d'ajouter ceux-ci, si vous souhaitez concerver le fonctionnement par défaut.
- les fonctions de spred s'applique également aux dossiers cachés. Par défaut, la fonction ftp_deploy, exclut les dossiers ".git/" et ".Rproj.user/". Si vous souhaitez ajouter d'autre exclusion, n'oubliez pas d'ajouter ceux-ci, pour concerver le fonctionnement par défaut.
```{r setup}
library(spred)
......@@ -53,7 +53,7 @@ ftp_deploy(
waitingpage = list(path="/../",type="en-shiny")
)
```
Réponse :
Exemple de réponse :
```
drwxrwxrwx 1 ftp ftp 0 Feb 20 15:51 projet
drwxrwxrwx 1 ftp ftp 0 Feb 20 15:51 projet
......@@ -104,7 +104,7 @@ ftp_dir_exist(Sys.getenv("FTP_CON_LOC"), Sys.getenv("FTP_URL_LOC"), "/")
</code>
### `ftp_write_only` écrire seulement les fichiers désirés sans nettoyer la destination au préalable
(utile si on souhaite seulement ajouter une contribution)
(utile si on souhaite seulement ajouter une contribution sans prendre le risque d'effacer le contenu existant)
```
#!Not working if FTP_CON_LOC, FTP_URL_LOC, dirfrom and dirto are not defined correctly
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment