Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add comment about branch name in tutorial #4

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add comment about branch name in tutorial #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,10 @@ Skip this if you already have doxygen configured

## Configuring automatic publishing using github actions
* Copy the action file `main.yml` to `.github/workflows/main.yml`
* Commit and Push to github
* Github action should automatically start running
* Confirm that github is set to deploy `gh-pages` branch in settings page
* Change the branch name from `master` to `main`, if applicable
* Commit and Push to Github
* Github Action should automatically start running
* Confirm that Github is set to deploy `gh-pages` branch in "Settings > Pages" page

## Notes
* Ensure that `publish_dir` in `main.yml` is set correctly
* Ensure that `publish_dir` in `main.yml` is set correctly