Skip to content

Commit

Permalink
Update sample work flow file in UG (#2556)
Browse files Browse the repository at this point in the history
* Add minute documentation changes

* Update docs

* Add info box

* Reposition info box

* Undo list autoformat

* Add info

Add notice to enable github pages on
first deployment

* Reposition enable github pages
  • Loading branch information
gerteck authored Jul 2, 2024
1 parent 2c82764 commit 968a980
Showing 1 changed file with 12 additions and 3 deletions.
15 changes: 12 additions & 3 deletions docs/userGuide/deployingTheSite.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,12 +38,15 @@

**MarkBind can easily deploy a site to [GitHub pages](https://help.github.com/categories/github-pages-basics/)** if the project root directory is also a GitHub repo.

<box type="info">

This documentation currently uses `master` as the default branch name. If your repository uses `main` as the default branch, you will need to update the references to `master` accordingly. For instance, when specifying the branch for deployment, replace instances of `master` with `main` to match your repository's configuration.
</box>

### Using the `markbind deploy` command

Running the **`markbind deploy`** command will deploy the most recent build of your site to the `gh-pages` branch of the repo `origin` and will be available.

Then, navigate to the `Settings > Pages` section on GitHub for that repository and set the source to the root of the `gh-pages` branch. You can read [this source](https://docs.github.com/en/pages/getting-started-with-github-pages/creating-a-github-pages-site#creating-your-site) on GitHub Pages for more details.

Your site will be online at `http://<username|org>.github.io/<repo>` (e.g., http://se-edu.github.io/se-book).

<div id="warning-about-baseUrl">
Expand Down Expand Up @@ -102,6 +105,8 @@ jobs:
build:
runs-on: ubuntu-latest
name: test
permissions:
contents: write
env:
GITHUB_TOKEN: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %}
steps:
Expand All @@ -118,7 +123,11 @@ jobs:
The sample `deploy.yml` workflow above uses the [default GitHub Token secret](https://docs.github.com/en/actions/reference/authentication-in-a-workflow) that is generated automatically for each GitHub Actions workflow. You may also use a [GitHub Personal Access Token](#generating-a-github-personal-access-token) in place of the default GitHub Token.
</box>

Once you have created the file, commit and push the file to your repo. GitHub Actions should start to build and deploy your MarkBind site. You can verify this by visiting `www.github.com/<org|username>/<repo>/actions`.
Once you have created the file, commit and push the file to your repo.

Then, navigate to the `Settings > Pages` section on GitHub for that repository and set the source to the root of the `gh-pages` branch. You can read [this source](https://docs.github.com/en/pages/getting-started-with-github-pages/creating-a-github-pages-site#creating-your-site) on GitHub Pages for more details.

GitHub Actions should start to build and deploy your MarkBind site. You can verify this by visiting `www.github.com/<org|username>/<repo>/actions`.

<box type="tip" id="markbind-action-tip">

Expand Down

0 comments on commit 968a980

Please sign in to comment.