Skip to contents

Vue d’ensemble

Le workflow policy brief (PB) est calqué sur celui des documents de travail (WP) : mêmes étapes (initialisation, vérification, rendu, déploiement), fonctions pb_* équivalentes aux fonctions wp_*, mêmes gabarits Quarto (_quarto.yml, index.qmd, annexes.qmd, news.qmd) et mêmes workflows GitHub Actions.

Ce document ne répète pas en détail ce qui est déjà couvert par la vignette WP ; il se concentre sur les différences propres aux PB : la numérotation par série et l’absence de version une fois le PB publié.

Séries de PB

Les PB sont répartis en séries, une par institut d’origine. Chaque série a sa propre numérotation, qui commence à 1. La série d’un dépôt est donnée par la clé pb_series de _quarto.yml (gabarit : ife). Un dépôt sans cette clé est traité comme appartenant à la série historique ofce, désormais close.

pb_series est indépendante de la clé institut, qui ne choisit que le logo du PB (ofce, ife, ife-ofce, ife-cepii, ife-ofce-cepii) : un PB co-signé IFE|OFCE peut très bien être numéroté dans la série ife.

La liste des séries et leurs paramètres vivent dans le registre central, pb/index.json du dépôt ofce/wp-registry — rien n’est codé en dur dans ofceweb :

Paramètre Série ofce Série ife
open (accepte de nouveaux numéros) non oui
path-prefix (sous www.ofce.fr/pb/) (aucun) ife/
pdf-prefix (PDF publié) OFCEPB IFEPB
draft-prefix (PDF brouillon) ofce-draft ife-draft
container-title (citation) Policy Brief de l’OFCE Policy Brief de l’IFE

pb/index.json déclare aussi min-ofceweb-version, la version minimale du package exigée par check_pb() (voir section 2).

Différences avec les WP

Working paper (WP) Policy brief (PB)
Fonctions setup_wp(), check_wp(), render_wp(), deploy_wp(), publish_wp(), wp_version_up(), wp_registry_request() setup_pb(), check_pb(), render_pb(), deploy_pb(), publish_pb(), pb_version_up(), pb_registry_request()
Numérotation par année (annee + wp) par série (pb_series + pb), chaque série à partir de 1 ; annee n’est pas utilisé
Registre central ofce/wp-registry, wp/{annee}.json même dépôt, pb/index.json (séries) + pb/{série}.json (entrées)
Branche de PR registre request/{annee}/{wp} request/pb/{série}/{pb}
Convention de nommage du dépôt wp-{initiales}-{nom court} pb-{initiales}-{nom court}
Versions brouillon et publié brouillon uniquement — un PB publié n’a plus de version
URL publiée www.ofce.fr/wp/{annee}/{N}/{version}/ www.ofce.fr/pb/{path-prefix}{N}/ (ex. www.ofce.fr/pb/ife/12/)
URL stable (citation) dérivée de annee/wp identique à l’URL publiée
Nom du PDF publié OFCEWP{annee}-{N}.pdf {pdf-prefix}{N}.pdf (ex. IFEPB12.pdf)
Nom du PDF brouillon — {draft-prefix}-{repo}-{version}.pdf (ex. ife-draft-pb-csskvv-chn-v1.pdf)
Formats Quarto wp-html, wp-pdf / wp-typst pb-html, pb-pdf / pb-typst (mutuellement exclusifs, comme pour les WP)
Favicon www/fofce-wp.png www/fofce-wp.png (partagé)
Marqueur _quarto.yml ofce_wp: true ofce_pb: true

setup_pb() refuse d’être appliqué à un dépôt marqué ofce_wp: true ou ofce_prev: true (et réciproquement pour setup_wp()) : un dépôt a un type unique.

Cycle de vie

État pb dans _quarto.yml version Hébergement URL
Brouillon absent v0, v1, … GitHub Pages ou OFCE staging ofce.github.io/{repo}/ ou staging.ofce.fr/{repo}/{version}/
Publié N (entier) absente Serveur OFCE FTP www.ofce.fr/pb/{path-prefix}{N}/

Un brouillon passe par autant de versions de revue que nécessaire. Le numéro n’est attribué qu’au moment où le PB est prêt à être publié (enregistrement dans le registre) ; à partir de là, il n’a plus de version : setup_pb() supprime la clé version de _quarto.yml, et une correction se fait en redéployant à la même adresse.

Comme pour les WP, pour être stagé sur staging.ofce.fr ou publié, la propriété du dépôt doit être transférée à l’organisation OFCE. Convention de nommage recommandée : pb-{initiales des auteur·es}-{nom court du projet}, tout en minuscules (ex. pb-csskvv-chn).

L’accès aux modifications du document, ainsi que la possibilité de le publier (staging ou définitif) découle des droits du dépôt. Ils sont definis dans les settings accessible sur la page github.com du dépôt. Par défaut, ce sont les auteurs et les administrateurs du site, que le dépôt soit privé ou public.


1. Initialiser un nouveau PB

library(ofceweb)

# Depuis la racine du dépôt GitHub du PB
setup_pb(
  path       = ".",
  lang       = "fr",
  hypothesis = FALSE
)

setup_pb() suit le même pipeline que setup_wp() : vérification de la connexion GitHub, initialisation de la branche gh-pages, copie des gabarits (_quarto.yml, index.qmd, annexes.qmd, news.qmd) et des assets OFCE, installation/mise à jour des extensions Quarto OFCE, mise à jour forcée des workflows GitHub Actions.

Différences notables :

  • pb n’est pas un argument de setup_pb() (contrairement à wp/annee pour setup_wp()) : il est toujours lu depuis _quarto.yml, ou écrasé par une entrée confirmée du registre central. Un dépôt sans entrée de registre reste un brouillon (pb absent) — pour obtenir un numéro, voir la section 5.
  • La série (pb_series) se choisit dans _quarto.yml, avant la demande de numéro. setup_pb() l’écrit explicitement (ofce si la clé manquait) et en tire, d’après pb/index.json, le site-path, le nom du PDF et citation.container-title. Si l’index est inaccessible, ces champs ne sont pas recalculés et un avertissement l’indique.
  • institut (le logo) vaut ife par défaut : setup_pb() l’ajoute à _quarto.yml s’il n’est déclaré ni là ni dans index.qmd, sans jamais modifier une valeur existante. Il ne dépend pas de pb_series.
  • L’argument versionning est obsolète et ignoré : un brouillon est toujours versionné, un PB publié ne l’est plus.

Après setup_pb(), éditez _quarto.yml et index.qmd pour les métadonnées définitives (auteurs, résumé, date, institut, pb_series) et le contenu avant de commiter.


2. Vérifier la structure avant rendu

check_pb() vérifie les mêmes catégories de champs que check_wp() (_quarto.yml obligatoires, index.qmd déclarant pb-html et pb-pdf/pb-typst, references.bib, news.qmd, unicité des output-file PDF, .qmd référencés dans website.other-links), avec des contrôles spécifiques aux PB :

  • version du package : si pb/index.json déclare une min-ofceweb-version supérieure à la version d’ofceweb installée, check_pb() renvoie une erreur, ce qui bloque render_pb() (et donc publish()) jusqu’à la mise à jour du package. Ce contrôle est propre aux PB : il n’affecte pas les WP ;
  • cohérence avec le registre central (numéro et série) ;
  • pour un PB publié : site-path égal à {path-prefix}{N}, sans segment de version ; plus de clé version ; présence de nb (le numéro lu par l’extension Quarto pb, sans lequel le PB s’affiche comme un brouillon). Tout se corrige en relançant setup_pb() ;
  • convention de nommage du dépôt pb-{initiales}-{nom court} (warning non bloquant, org GitHub ofce uniquement).

Elle retourne un data frame de diagnostics et est appelée automatiquement par render_pb(). complete_pb_yaml() (équivalent de complete_wp()) peut compléter automatiquement les champs obligatoires manquants (date, author, citation).


3. Rendre le PB

render(
  path        = ".",
  check       = TRUE,   # appeler check_pb() avant rendu
  render_site = TRUE,   # lancer un serveur local après rendu
  site2branch = FALSE   # pousser vers la branche de déploiement
)

Pipeline identique à render_wp() (vidage de _site/, rendu HTML + PDF via quarto::quarto_render(), reconstruction du sitemap, écriture de manifest.json, synchronisation de FTP_SERVER_DIR, réécriture des liens absolus en relatifs, prévisualisation locale via servr::httw()), à une différence près : render_pb() ne consulte pas le registre central — cette consultation a lieu en amont, dans setup_pb() (et à nouveau dans publish_pb()). render_pb() suppose que draft/pb/pb_series sont déjà synchronisés dans _quarto.yml.


4. Déployer le PB

Le comportement dépend de l’état stage (lu depuis manifest.json, écrit par render_pb()) et, avant publication, de stage-target dans _quarto.yml :

  • Publié (stage: FALSE) → toujours vers FTP production (ftp_deploy.yml), quelle que soit la valeur de stage-target, à l’adresse unique www.ofce.fr/pb/{path-prefix}{N}/. Il n’y a pas de page de redirection : un PB publié n’a qu’une adresse. Redéployer remplace le contenu à cette adresse (c’est ainsi qu’on corrige un PB publié).
  • Non encore publié (stage: TRUE ou absent) → destination lue depuis stage-target : "auto" (réévalué à chaque appel selon le propriétaire GitHub actuel — "ftp" pour l’organisation ofce, "gh-pages" sinon), ou forcée via "ftp" / "gh-pages". En staging FTP, une redirection staging.ofce.fr/{repo}/ pointe vers la dernière version du brouillon (push_pb_staging_redirect()).

5. Passer de brouillon à publié

Comme pour les WP, le numéro (pb) est la propriété du registre central, pas de l’auteur·e. PB et WP partagent le même dépôt registre (ofce/wp-registry), dans des sous-dossiers distincts : pb/ pour les PB (un fichier par série, pb/{série}.json, et l’index pb/index.json), wp/{annee}.json pour les WP. L’ancien fichier plat pb/pb.json est figé : la CI du registre refuse toute modification.

  1. Vérifier pb_series dans _quarto.yml (une série ouverte, par exemple ife), puis demander un numéro :
La fonction refuse la demande si la série est inconnue ou close, si
l'index est inaccessible, ou si le dépôt est déjà enregistré. Sinon,
elle prend le numéro suivant **dans la série** (`max + 1`, ou `1`
pour une série encore vide) et ouvre une pull request contre
`ofce/wp-registry` qui ajoute l'entrée à `pb/{série}.json`, depuis
une branche `request/pb/{série}/{pb}`. Le dépôt registre autorise les
membres de l'organisation `ofce` à pousser une branche et ouvrir une
PR sans droit d'écriture — seule la **fusion** reste protégée (branch
protection + `CODEOWNERS`). La fonction n'attend pas la fusion ;
un·e admin OFCE doit approuver manuellement. La CI du registre
refuse un numéro en double dans une série, un dépôt enregistré deux
fois, et tout nouveau numéro dans une série close.
  1. Une fois la PR fusionnée, relancer setup_pb(). Il synchronise pb/pb_series/draft depuis le registre, supprime la clé version, calcule site-path ({path-prefix}{N}), citation.url/stable_url (https://www.ofce.fr/pb/{path-prefix}{N}/), citation.issue ("{N}"), nb, le nom du PDF publié et la variable FTP_SERVER_DIR :
  1. Rendre et déployer :

publish() (qui enchaîne render() et deploy()) refait cette consultation du registre juste avant le rendu, pour rattraper un enregistrement survenu depuis le dernier setup_pb() — mais ne recalcule que draft/pb/pb_series, pas site-path/citation.* : si le numéro ou la série change à cette étape, relancer setup_pb() avant de publier à nouveau.


6. Chiffrement (optionnel)

Identique aux WP : géré exclusivement en CI, activé/désactivé via le secret STATICRYPT_PASSWORD sur le dépôt (voir la vignette Documents de travail (Working Papers), section 6).


7. Nouvelle version d’un brouillon

pb_version_up()                              # v0 -> v1, v1 -> v2, etc.
pb_version_up(custom_version = "v1_corr")    # version personnalisée

Met à jour version et, pour un brouillon en staging FTP, le dernier segment de website.site-url dans _quarto.yml, la variable GitHub FTP_STAGING_DIR, et régénère manifest.json. Relancer setup_pb() pour renommer le PDF brouillon (qui porte la version).

pb_version_up() refuse de tourner sur un PB publié : un PB publié n’a plus de version, on le corrige en redéployant à la même adresse.


8. Manifeste JSON

pb_manifest() (appelée automatiquement par render_pb()) génère manifest.json. Aucun outil ne le collecte encore (les listes de publications de webhome sont tenues à la main) ; un futur collecteur devra identifier un PB par le couple (pb_series, pb), pas par pb seul. Exemple pour un PB publié :

{
  "title": "Mon policy brief",
  "authors": [{"name": "Prénom Nom", "affiliation": "IFE, Sciences Po Paris"}],
  "abstract": "Résumé...",
  "pb": 12,
  "pb_series": "ife",
  "version": null,
  "stage": false,
  "date": "2026-11-19",
  "date_modified": "2026-11-30",
  "url": "https://www.ofce.fr/pb/ife/12/",
  "pdf": "IFEPB12.pdf",
  "pdf-path": "pb/ife/12/IFEPB12.pdf",
  "repo": "https://github.com/ofce/pb-csskvv-chn/",
  "lang": "fr",
  "source-repo": "ofce/pb-csskvv-chn"
}

Le champ source-repo ("owner/repo") permet au workflow ftp_deploy.yml de détecter qu’un autre dépôt tenterait de publier à la même adresse (même série, même numéro) et de bloquer ce déploiement avant d’écraser le PB existant — c’est la « vérification anti-collision » mentionnée dans les workflows.


Structure d’un dépôt PB

mon-pb/
├── _quarto.yml          # métadonnées PB (pb_series, institut, pb, version tant que brouillon, auteurs, …)
├── index.qmd            # corps du document
├── annexes.qmd          # annexes (optionnel)
├── news.qmd             # historique des révisions
├── references.bib       # bibliographie
├── manifest.json        # manifeste JSON (généré par render_pb)
├── www/                 # assets OFCE (logos, icônes)
├── _extensions/ofce/    # extension Quarto ofce
└── .github/workflows/
    ├── ftp_deploy.yml           # déploiement FTP (PB publié)
    ├── ftp_stage.yml            # déploiement FTP staging (brouillon)
    ├── ftp_redirect_staging.yml # redirection staging vers la dernière version du brouillon
    └── gh-pages.yml             # déploiement GitHub Pages (brouillon)