Skip to content

Commit 7953197

Browse files
matibouxmatiboux
authored
Initialize documentation site with Astro Starlight (#1)
1 parent 94cfd90 commit 7953197

27 files changed

+6359
-1
lines changed

‎.editorconfig

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# https://editorconfig.org
2+
root = true
3+
4+
# Unix-style newlines with a newline ending every file
5+
[*]
6+
charset = utf-8
7+
end_of_line = lf
8+
insert_final_newline = true
9+
indent_style = tab
10+
indent_size = 4
11+
12+
# Markdown
13+
[*.{md,markdown}]
14+
indent_style = space
15+
indent_size = 2
16+
17+
# YAML
18+
[*.{yml,yaml}]
19+
indent_style = space
20+
indent_size = 2
21+
22+
# JSON
23+
[**.{json}]
24+
indent_style = space
25+
indent_size = 2

‎.env

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
COMPOSE_PROJECT_NAME='fluffevent-help'
2+
IMAGES_PREFIX='fluffevent-help'
3+
4+
# Override these values with your own in `.env.local`:
5+
6+
# HTTP ports
7+
HTTP_PORT='' # Exposed port
8+
HTTP_DOCKER_PORT='' # Container port
9+
10+
# Application configuration
11+
GITHUB_REPOSITORY_URL=''
12+
GITHUB_SHA=''

‎.github/workflows/check.yml

+105
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
name: Check CI
2+
3+
on:
4+
5+
# Run on pull requests to primary branches
6+
pull_request:
7+
branches:
8+
# Production
9+
- main
10+
# Development
11+
- dev
12+
paths:
13+
# CI files
14+
- '.github/workflows/check.yml'
15+
- 'docker-compose.yml'
16+
- 'docker-compose.cicd.yml'
17+
- '.env'
18+
# Application files
19+
- 'app/**'
20+
21+
# Run on manual triggers
22+
workflow_dispatch:
23+
24+
# Set GITHUB_TOKEN permissions for the workflow
25+
permissions:
26+
contents: read
27+
28+
# Set workflow concurrency rules
29+
concurrency:
30+
group: ${{ github.workflow }}-${{ github.event_name }}-${{ github.ref }}
31+
cancel-in-progress: true
32+
33+
jobs:
34+
35+
# Build job
36+
build:
37+
name: Build
38+
runs-on: ubuntu-latest
39+
timeout-minutes: 15
40+
41+
steps:
42+
43+
# Steps dependencies
44+
45+
- name: Checkout
46+
uses: actions/checkout@v4
47+
48+
# Execution steps
49+
50+
- name: Copy Git history in app source folder
51+
run: |
52+
# Copy app source code git history
53+
# Initialize Git repository in app source code directory
54+
(
55+
cd app/app &&
56+
rm -rf .git &&
57+
git init -b main &&
58+
git config receive.denyCurrentBranch ignore
59+
)
60+
# Get Git history of app source code
61+
git subtree split --prefix=app/app -b app-history
62+
# Push Git history to app source code directory
63+
(
64+
git remote add app ./app/app/.git &&
65+
git push app app-history:main &&
66+
git branch -D app-history &&
67+
git remote remove app
68+
)
69+
70+
- name: Pull dependencies
71+
run: |
72+
# docker compose pull --ignore-buildable
73+
docker compose \
74+
-f ./docker-compose.yml -f ./docker-compose.cicd.yml \
75+
--env-file .env \
76+
pull --ignore-buildable
77+
78+
- name: Build for production
79+
env:
80+
GITHUB_REPOSITORY_URL: https://github.com/${{ github.repository }}
81+
GITHUB_SHA: ${{ github.sha }}
82+
BUILD_CHECK: "true" # Run type checks
83+
run: |
84+
# docker compose build
85+
export DOCKER_UID="$(id -u)"
86+
docker compose \
87+
-f ./docker-compose.yml -f ./docker-compose.cicd.yml \
88+
--env-file .env \
89+
build
90+
91+
- name: Copy application files
92+
run: |
93+
# docker compose up
94+
export DOCKER_UID="$(id -u)"
95+
docker compose \
96+
-f ./docker-compose.yml -f ./docker-compose.cicd.yml \
97+
--env-file .env \
98+
up
99+
100+
- name: Check application files
101+
run: |
102+
# Check application files
103+
[ -d ./app/dist ] && [ $(ls -1 ./app/dist | wc -l) -gt 0 ] \
104+
&& echo "Application files found" \
105+
|| ( echo "No application files found" && exit 1 )

‎.github/workflows/deploy.yml

+127
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
1+
name: Deploy CD
2+
3+
on:
4+
5+
# Run on push on production branches
6+
push:
7+
branches:
8+
# Production
9+
- main
10+
paths:
11+
# CI files
12+
- '.github/workflows/deploy.yml'
13+
- 'docker-compose.yml'
14+
- 'docker-compose.cicd.yml'
15+
- '.env'
16+
# Application files
17+
- 'app/**'
18+
19+
# Run on manual triggers
20+
workflow_dispatch:
21+
22+
# Set GITHUB_TOKEN permissions for the workflow
23+
permissions:
24+
contents: read
25+
26+
# Set workflow concurrency rules
27+
concurrency:
28+
group: ${{ github.workflow }}
29+
cancel-in-progress: true
30+
31+
jobs:
32+
33+
# Build job
34+
build:
35+
name: Build
36+
runs-on: ubuntu-latest
37+
timeout-minutes: 15
38+
39+
steps:
40+
41+
# Steps dependencies
42+
43+
- name: Checkout
44+
uses: actions/checkout@v4
45+
46+
# Execution steps
47+
48+
- name: Copy Git history in app source folder
49+
run: |
50+
# Copy app source code git history
51+
# Initialize Git repository in app source code directory
52+
(
53+
cd app/app &&
54+
rm -rf .git &&
55+
git init -b main &&
56+
git config receive.denyCurrentBranch ignore
57+
)
58+
# Get Git history of app source code
59+
git subtree split --prefix=app/app -b app-history
60+
# Push Git history to app source code directory
61+
(
62+
git remote add app ./app/app/.git &&
63+
git push app app-history:main &&
64+
git branch -D app-history &&
65+
git remote remove app
66+
)
67+
68+
- name: Pull dependencies
69+
run: |
70+
# docker compose pull --ignore-buildable
71+
docker compose \
72+
-f ./docker-compose.yml -f ./docker-compose.cicd.yml \
73+
--env-file .env \
74+
pull --ignore-buildable
75+
76+
- name: Build for production
77+
env:
78+
GITHUB_REPOSITORY_URL: https://github.com/${{ github.repository }}
79+
GITHUB_SHA: ${{ github.sha }}
80+
BUILD_CHECK: "false" # Skip type checks
81+
run: |
82+
# docker compose build
83+
export DOCKER_UID="$(id -u)"
84+
docker compose \
85+
-f ./docker-compose.yml -f ./docker-compose.cicd.yml \
86+
--env-file .env \
87+
build
88+
89+
- name: Copy application files
90+
run: |
91+
# docker compose up
92+
export DOCKER_UID="$(id -u)"
93+
docker compose \
94+
-f ./docker-compose.yml -f ./docker-compose.cicd.yml \
95+
--env-file .env \
96+
up
97+
98+
- name: Upload GitHub Pages artifact
99+
uses: actions/upload-pages-artifact@v3
100+
with:
101+
path: ./app/dist
102+
103+
# Deploy job
104+
deploy:
105+
name: Deploy
106+
runs-on: ubuntu-latest
107+
timeout-minutes: 10
108+
109+
# Job dependencies
110+
needs:
111+
- build
112+
113+
# Set GITHUB_TOKEN permissions for the job
114+
permissions:
115+
pages: write
116+
id-token: write
117+
118+
# Set deployment environment
119+
environment:
120+
name: production
121+
url: ${{ steps.deployment.outputs.page_url }}
122+
123+
steps:
124+
125+
- name: Deploy to GitHub Pages
126+
id: deployment
127+
uses: actions/deploy-pages@v4

‎.gitignore

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# -- Generic rules:
2+
3+
# Environment files
4+
.env*.local
5+
6+
# Temporary files
7+
._*
8+
*.cache
9+
*.log*
10+
*.swp
11+
*~
12+
13+
# System files
14+
.DS_Store
15+
Thumbs.db
16+
17+
# -- Editor rules:
18+
19+
# VS Code
20+
.vscode/**/*
21+
!.vscode/extensions.json
22+
23+
# Jetbrains
24+
.idea/
25+
26+
# Other
27+
*.suo
28+
*.ntvs*
29+
*.njsproj
30+
*.sln
31+
*.sw?
32+
33+
# -- Application rules:
34+
35+
# Node.js
36+
node_modules/
37+
.pnpm-store/
38+
dist/
39+
40+
# Astro
41+
.astro/
42+
.vite/
43+
44+
# Application environment files
45+
*/**/.env*
46+
47+
# -- Specific to gitignore:
48+
49+
# N/A

‎.vscode/extensions.json

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"recommendations": [
3+
"astro-build.astro-vscode"
4+
],
5+
"unwantedRecommendations": []
6+
}

‎README.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,5 @@
1-
# Fluff Event Help Website
1+
# Fluff Event Help website
2+
3+
The help and documentation website for [Fluff Event](https://fluffEvent.fr).
4+
5+
Visit this website at [help.fluffEvent.fr](https://help.fluffEvent.fr).

‎app/.dockerignore

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# -- Generic rules:
2+
3+
# Environment files
4+
.env*.local
5+
6+
# Temporary files
7+
._*
8+
*.cache
9+
*.log*
10+
*.swp
11+
*~
12+
13+
# System files
14+
.DS_Store
15+
Thumbs.db
16+
17+
# -- Editor rules:
18+
19+
# VS Code
20+
.vscode/**/*
21+
!.vscode/extensions.json
22+
23+
# Jetbrains
24+
.idea/
25+
26+
# Other
27+
*.suo
28+
*.ntvs*
29+
*.njsproj
30+
*.sln
31+
*.sw?
32+
33+
# -- Application rules:
34+
35+
# Node.js
36+
node_modules/
37+
dist/
38+
39+
# Astro
40+
.astro/
41+
.vite/
42+
43+
# Application environment files
44+
*/**/.env*
45+
46+
# -- Specific to dockerignore:
47+
48+
# Docker configuration files
49+
Dockerfile
50+
docker-compose*.yml
51+
52+
# Dotfiles
53+
.*

0 commit comments

Comments
 (0)