Le blog de Sud Web

Site internet du cycle de conférences annuel Sud Web, dont la 7e édition aura lieu à Anduze les 25 et 26 mai 2018.

https://sudweb.fr/

Pré-requis

Le site est généré à l'aide de Jekyll et nécessite Ruby 2.4.0 (voir .ruby-version)

Nous vous recommandons de gérer l'installation de Ruby via rbenv.

Sous Mac OS X, vous pouvez utiliser Homebrew pour cela

$ brew install rbenv ruby-build

Sous GNU/Linux, certaines librairies sont nécessaires (à adapter à votre gestionnaire de paquets) :

sudo apt-get install -y libreadline-dev build-essential

Puis pour rbenv et ruby-build, préférer une installation par git :

$ git clone https://github.com/rbenv/rbenv.git ~/.rbenv
$ cd ~/.rbenv && src/configure && make -C src
$ echo 'export PATH="$HOME/.rbenv/bin:$PATH"' >> ~/.bashrc
$ git clone https://github.com/rbenv/ruby-build.git ~/.rbenv/plugins/ruby-build

Installation

Si vous n'avez pas déjà cloné le dépot :

$ git clone https://github.com/sudweb/2018.git && cd 2018

Si bundler n'est pas installé

$ gem install bundler

Pour installer toutes les dépendances du projet :

$ bundle install;
$ bundle exec rake prebuild:install;

Pour installer la bonne version de Ruby avec rbenv :

$ rbenv install

Travailler en local

Pour travailler sur le site et surveiller les modifications :

$ bundle exec rake build:serve

Pour builder pour le Dév

$ bundle exec rake build:dev

Pour builder pour la Production

$ bundle exec rake build:prod

Si vous modifiez le fichier _config.yml, il faut couper et relancer.

Le site est maintenant accessible en local à l'adresse http://127.0.0.1:4000/ (dev).

Pour plus d'information sur l'utilisation de Jekyll, reportez-vous à la documentation officielle.

Production

Le blog est déployé sur un serveur AlwaysData par le biais de GitHub Actions.

Le script de déploiement se trouve dans le fichier .github/workflows/deploy.yml. Pour fonctionner, il a besoin d’une clé SSH privée valide.

Pour générer et autoriser une nouvelle clé SSH, à exécuter sur votre machine locale :

$ # Génère la clé SSH elle-même (lorsqu’il vous sera demandé, ne précisez pas de mot de passe)
$ ssh-keygen -o -a 100 -t ed25519 -f ./deploykey -C "[email protected]"
$
$ # Autorise la clé à être utilisée pour se connecter au serveur (il vous sera demandé le mot de passe de l’utilisateur sudweb_blog)
$ ssh-copy-id -i deploykey.pub [email protected]
$
$ # Copie la clé privée dans votre presse-papier
$ cat deploykey | xsel --clipboard

Il ne reste plus qu’à coller la valeur copiée en valeur de la variable d’environnement SSH_PRIVATE_KEY pour l’environnement production-alwaysdata.

Le script a également besoin d’une variable d’environnement SSH_KNOWN_HOSTS dont vous pouvez générer la valeur avec la commande suivante :

$ ssh-keyscan ssh-sudweb.alwaysdata.net

Contribution

Pour toute demande, merci de créer une issue sur GitHub.

Si vous souhaitez nous aider, vous pouvez copier le dépôt, faire vos modifications dans une nouvelle branche et faire une demande de fusion.

Toute modification doit faire l'objet d'une pull request et doit passer les tests avant de pouvoir être fusionnée.

Tests

Avant de soumettre votre pull-request, vérifiez que les tests passent :

$ bundle exec rake postbuild:test:kiss

Licence

Ce code est publié sous licence MIT.