When you run this command, it will do the following:
(first, it calls use_pkgdown()) - you have done this already so this will just check that.
use_github_pages() prepares to publish the pkgdown site from the gh-pages branch
use_github_action("pkgdown") configures a GitHub Action to automatically build the pkgdown site and deploy it via GitHub Pages
The pkgdown site's URL is added to the pkgdown configuration file, to the URL field of DESCRIPTION, and to the GitHub repo.
You can run this command on any branch. When the gh-pages branch is created, you should make sure not to touch/do anything with that branch. That branch will now only contain HTML files for your site and not the code in your main or any other branches. That branch gets updated automatically by the workflow. So make sure that you are not on that branch at anytime.
If you initiated this command on a branch that is not the main branch, the github actions yaml for the automation will be in that branch only. But the github action for pkgdowm will only deploy to gh-pages when changes have been merged to main. So, make sure that the yaml file for the new github action gets merged to main.
once that has been setup, every time you merge to main, the pkgdown workflow will run and then deploy to gh-pags branch.
When you run this command, it will do the following:
(first, it calls use_pkgdown()) - you have done this already so this will just check that.
use_github_pages()prepares to publish the pkgdown site from the gh-pages branchuse_github_action("pkgdown")configures a GitHub Action to automatically build the pkgdown site and deploy it via GitHub PagesThe pkgdown site's URL is added to the pkgdown configuration file, to the URL field of DESCRIPTION, and to the GitHub repo.
You can run this command on any branch. When the
gh-pagesbranch is created, you should make sure not to touch/do anything with that branch. That branch will now only contain HTML files for your site and not the code in your main or any other branches. That branch gets updated automatically by the workflow. So make sure that you are not on that branch at anytime.If you initiated this command on a branch that is not the main branch, the github actions yaml for the automation will be in that branch only. But the github action for pkgdowm will only deploy to gh-pages when changes have been merged to main. So, make sure that the yaml file for the new github action gets merged to main.
once that has been setup, every time you merge to main, the pkgdown workflow will run and then deploy to gh-pags branch.
You will then see your website at https://tomaszaba.github.io/ipccheckr