Create release.yml

Signed-off-by: Helene MJ <[email protected]>

Author: hjonin

.github/workflows/release.yml

@@ -0,0 +1,25 @@
+name: Main
+
+on:
+  push:
+    tags:
+      - "v*.*.*"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          cache: 'npm'
+      - name: Build
+        run: |
+          npm install
+          npm run build
+          tar -czvf docsfr.tar.gz docs
+      - name: Release
+        run: gh release create ${{ github.ref }} ./docsfr.tar.gz
+        env:
+          GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}

.nojekyll

@@ -7,7 +7,7 @@ Ce dépôt permet de générer un template de site de documentation basé sur le
 
 ## Utilisation
 
-- Télécharger le répertoire ([/docs](/docs)) contenant les fichiers du template.
+- Télécharger le paquet attaché à la release contenant les fichiers du template.
 - Déposer les fichiers dans votre répertoire contenant la documentation, ou commencer votre documentation à partir de ce répertoire.
 
 ## Développement
@@ -20,11 +20,16 @@ git clone [email protected]:codegouvfr/docsify-dsfr-template.git
 ```
 npm install
 ```
-- Construire le livrable dans [`/docs`](/docs) :
+- Construire les fichiers du livrable dans [`docs`](docs) :
 ```
 npm run build
 ```
 - Lancer le serveur pour visualiser les modifications en temps réel (SCSS seulement) :
 ```
 npm run serve-sass
 ```
+
+## Packaging
+
+L'empaquetage est automatisé via le workflow github [`release.yml`](.github/workflows/release.yml).
+Ce workfow nécessite un [secret de dépôt](https://docs.github.com/fr/actions/security-guides/using-secrets-in-github-actions#creating-secrets-for-a-repository) `GH_TOKEN` (peut être par exemple généré depuis un compte générique), correspondant à un [token d'accès classique](https://docs.github.com/fr/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#cr%C3%A9ation-dun-personal-access-token-classic), nécessitant le scope `repo`.

README.md

@@ -1,10 +1,9 @@
-const {src, dest, watch, series} = require('gulp');
+const {src, dest, series} = require('gulp');
 
 function docsify(callback) {
     src('./src/index.html')
         .pipe(src('./src/_sidebar.md'))
         .pipe(src('./README.md'))
-        .pipe(src('./.nojekyll'))
         .pipe(dest('./docs'));
     callback();
 }