Skip to content

Commit 1b207e9

Browse files
Merge pull request #23 from AIML4OS/improvements2
Add a section on github checks
2 parents c3455bc + b01bbca commit 1b207e9

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

index.qmd

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -500,7 +500,21 @@ git push origin gh-pages # Pushing so that the gh-pages branch exists on the rem
500500
git checkout main
501501
```
502502

503-
### Setting up a Github Actions workflow
503+
### Check Github settings
504+
505+
After you created the branch `gh-pages`, you have to check that Github actually understood that the website needed to be deployed from this branch. This is fairly easy:
506+
507+
- Go to your repository on Github and click on `Settings`;
508+
509+
![](pics/SSPCloud11.png){width=600}
510+
511+
- Go to the `Pages` tab (red rectangle);
512+
- Check that the `Source` setting is set to `Deploy from a branch` (blue rectangle);
513+
- Check that the `Branch` setting is set to `gh-pages` (green rectangle).
514+
515+
![](pics/SSPCloud12.png){width=600}
516+
517+
### Set up a Github Actions workflow
504518

505519
You need to define a Github Actions workflow to automate output construction and deployment. A GHA workflow is a list of instructions (for instance: install `R`, install packages...) that are executed automatically every time a certain event happens (for instance every time you push on the main branch). A GHA workflow is defined using specific `yaml` scripts, located in the `.github/workflows` directory of your repository. __The templates already contain standard workflows that you can use as a starting point.__ We recommend that you have a careful look at these workflows; comments were added so that they are easy to follow.
506520

0 commit comments

Comments
 (0)