-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added usage for deploying on github.
- Loading branch information
1 parent
217fffa
commit 4c421ec
Showing
2 changed files
with
31 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
venv | ||
public |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -7,3 +7,32 @@ | |
</div> | ||
|
||
|
||
## Deploy to GH Pages on Change | ||
|
||
1. Follow the [guide](https://docs.github.com/en/pages/getting-started-with-github-pages/creating-a-github-pages-site#creating-a-repository-for-your-site) for enabling gh pages for your account. | ||
2. Set und Settings > Pages > GitHub Pages > Build and deployment Source to `GitHub Actions`. | ||
3. Create a yaml file in `.github/workflows` folder (for example `webpage.yaml`) and put the following content into it: | ||
|
||
```yaml | ||
name: Webpage | ||
|
||
on: | ||
push: | ||
branches: | ||
- main | ||
paths: | ||
- "install.cfg" | ||
|
||
jobs: | ||
webpage: | ||
runs-on: ubuntu-latest | ||
name: Compile Webpage | ||
steps: | ||
- name: Compile Webpage | ||
uses: instructions-d-installation/[email protected] | ||
- name: Deploy Webpage | ||
uses: peaceiris/actions-gh-pages@v4 | ||
with: | ||
github_token: ${{ secrets.GITHUB_TOKEN }} | ||
publish_dir: ./public | ||
``` |