NixiN/nixin-web
NixiN/nixin-web
2
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update readme
All checks were successful
deploy to prod / Build and deploy site (push) Successful in 49s
Details

Browse source
This commit is contained in:
Douze Bé 2024-09-26 22:46:27 +02:00
parent cb2989a439
commit c08c4f1f10
1 changed files with 13 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -7,8 +7,18 @@ npm run docs:build
## Testing localy ## Testing localy
npm run docs:dev npm run docs:dev
## Manually deploying to a server ## Manually deploying to a server usign sftp
pushd .vitepress/dist/ ; echo "put -r *" | sftp -b - -N user@server.domain.tld:www ; popd pushd .vitepress/dist/ ; echo "put -r *" | sftp -b - -N user@server.domain.tld:www ; popd
## Automatically deploying to a server ## Automatically deploying to a server with forgejo action
check the action in .forgejo/workflows/deploy.yaml Development is taking place in the main branch, or in feature branches that are then merged into main.
To deploy the web site to production server the changes in main branch are merged to the prod branch, which is triggering the deploy action, defined in .forgejo/workflows/deploy.yaml
This action builds the web site (`npm run docs:build`) and then deploys it to the production server using sftp with public/private key authentiction
You can use the script in bin/push-to-prod.sh to perform the merge of main branch into prod branch
if you forked this repository, you need to create the secrets needed by the deploy action (in repository settings->actions->secrets) :
- DEPLOY_USER : OS user to connect to production server
- DEPLOY_TARGET : sftp target where the web site has to be deployed, in the form of server.domain.tld:path
- DEPLOY_SSH_PRIVATE_KEY : private ssh key used to authenticate with the server
and configure the server witht the public key corresponding to DEPLOY_SSH_PRIVATE_KEY