Skip to content

Commit

Permalink
Tidy up ops (#20801)
Browse files Browse the repository at this point in the history
* ci: remove the nginx bits

We don't seem to use that "setup Nginx within the CI pipeline" code so
let's not carry it along.

* ci: remove unused build script

* docker: remove the compose hyphenation

* doc: tidy up the contribution guide

* docker: don't shadow the `node_modules` folder

c.f betagouv/rails-template@1f69642

* ci: remove an obsolete test script

All of the script content has been backported into the GitHub action
workflow.
  • Loading branch information
freesteph authored Oct 8, 2024
1 parent 31b2eda commit d58ee1b
Show file tree
Hide file tree
Showing 7 changed files with 12 additions and 106 deletions.
54 changes: 8 additions & 46 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,60 +38,22 @@ Les créations et modifications de fiches membres peuvent se faire via l'[Espace

## Développement en local

### Utilisation de Jekyll
Ce site est construit avec [Jekyll](https://jekyllrb.com/).

Ce site est construit avec [Jekyll](https://jekyllrb.com/), un générateur de sites statiques. La version utilisée est la [3.8.5](https://github.com/jekyll/jekyll/releases/tag/v3.8.5/).

Pour initialiser votre environnement de développement, commencez par installer [Ruby](https://www.ruby-lang.org/fr/) dans la version spécifiée par le fichier `.ruby-version`.
Si vous utilisez RVM pour isoler votre environnement, vous pouvez le faire avec la commande suivante :
Pour lancer le serveur et commencer à développer, un environnement
Docker est fourni. Des commandes utiles sont fournies dans le
[`Makefile`](./Makefile), mais pour démarrer :

```sh
rvm install `cat .ruby-version`
docker compose up
```

Toujours avec RVM, vous pouvez créer un fichier `.ruby-gemset` contenant un nom de gemset à utiliser en local.
Il vous suffit alors de sortir puis revenir du répertoire pour que le gemset soit créé correctement si votre shell est bien configuré.

Ensuite, exécutez les commandes suivantes :
Si vous préférez installer le projet sur votre système :

```sh
git clone https://github.com/betagouv/beta.gouv.fr.git
cd beta.gouv.fr
gem install bundler --no-ri --no-rdoc
npm install
bundle install
bundle exec jekyll serve
```

#### Gestion des dépendances

Afin de minimiser les écarts entre les versions de développement et les versions de production, ce dépôt contient un fichier `Gemfile` (spécification des versions minimum des dépendances), comme beaucoup de dépôts Ruby.

### Développement local avec Docker

Un environnement de developpement local basé sur docker, est disponible.
Les prérequis d'execution sont :
- Makefile
- docker
- docker-compose
- npm

Pour lancer son environnement local:
```bash
# Installation des assets à copier
npm i

# Génération des fichiers
make build

# Exécution des tests
make test

# Lancement de Jekyll
make up

# Arrêt de Jekyll
make down
npm install
bundle exec jekyll serve --incremental --livereload
```

Le site beta.gouv est alors accessible en local sur `http://localhost:4000`
Expand Down
14 changes: 3 additions & 11 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,17 @@ DOCKER-RUN = docker compose run -e TERM --rm
BUNDLE-EXEC = bundle exec

build:
$(DOCKER-RUN) web /bin/bash -c 'ci/build.sh'
test:
$(DOCKER-RUN) web /bin/bash -c 'ci/test.sh'
docker compose build
spec:
$(DOCKER-RUN) web $(BUNDLE-EXEC) rspec
guard:
$(DOCKER-RUN) web $(BUNDLE-EXEC) guard
up:
docker-compose up
docker compose up
down:
docker-compose down
docker compose down
sh:
$(DOCKER-RUN) web bash
rm:
docker-compose rm -sf
up-nginx: down-nginx
docker-compose -f docker-compose.nginx.yml up -d
down-nginx:
docker-compose -f docker-compose.nginx.yml down

html-proofer:
bundle exec htmlproofer ./_site/ --ignore-files "/recrutement\/*/" --no-enforce-https --disable-external --root_dir _site/ --allow-missing-href
Expand Down
15 changes: 0 additions & 15 deletions ci/build.sh

This file was deleted.

3 changes: 0 additions & 3 deletions ci/prepare-nginx-servers.conf.sh

This file was deleted.

19 changes: 0 additions & 19 deletions ci/test.sh

This file was deleted.

12 changes: 0 additions & 12 deletions docker-compose.nginx.yml

This file was deleted.

1 change: 1 addition & 0 deletions docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ services:
build: .
volumes:
- .:/app
- /app/node_modules
ports:
- "4000:4000"
- "35729:35729"

0 comments on commit d58ee1b

Please sign in to comment.