Skip to content

Commit

Permalink
expleained autometed deployment
Browse files Browse the repository at this point in the history
  • Loading branch information
Danura30082 committed Nov 27, 2024
1 parent 6a3635c commit f30b1a0
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 2 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
on:
push:
branches:
branches: # triggers the workflow on push events to the main branch
- main
workflow_dispatch:
workflow_dispatch: # allows you to run the workflow manually
jobs:
my_job:
name: deploy to staging
Expand Down
3 changes: 3 additions & 0 deletions docs/building_docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,9 @@ For full documentation visit [mkdocs.org](https://www.mkdocs.org).
* `mkdocs serve` - Start the live-reloading docs server. It should now be accesible at [127.0.0.1:8000](http://127.0.0.1:8000/) on ***your machine***
* `mkdocs gh-deploy` - Build the documentation site on the gh-pages branch of you repository.

!!! Note
On the [Club-INTech/CoVAPSy](https://github.com/Club-INTech/CoVAPSy) repository `mkdocs gh-deploy` is automaticly called upon push to main branch. It can still be manually called when on another branch but [gh-pages](https://github.com/Club-INTech/CoVAPSy/tree/gh-pages) will be overwritten by any push on main

### Project layout

mkdocs.yml ## The configuration file.
Expand Down

0 comments on commit f30b1a0

Please sign in to comment.