Skip to content

Commit

Permalink
address PR comments on README
Browse files Browse the repository at this point in the history
  • Loading branch information
ravi-kumar-pilla committed Jul 25, 2024
1 parent 9b554c3 commit 21f975b
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,13 @@ This action helps in the automation of a deployment strategy mentioned in [platf
- **Kedro-project dependencies:** Install all the Kedro-project dependencies before using this action in your workflow.
- **Python-version:** You need to have an environment with `python>=3.9` in your workflow.

**NOTE:** While configuring your repository for GitHub Pages, you have two publishing source options. You can either choose a branch or a custom GitHub Actions workflow (recommended). If you choose a branch, the build artifacts will be uploaded to the `publish_branch` you pass as an input to the action, which defaults to `gh-pages`. If you choose a custom GitHub Actions workflow, you need to mention that in the input `publishing_source` to the action (this is made as default from v2). In this case, no branch will be created and the artifacts are deployed at run-time. Please find more information on configuring a publishing source for github pages site in the [official docs](https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site).
> [!NOTE]
> While configuring your repository for GitHub Pages, you have two publishing source options. You can either choose a branch or a custom GitHub Actions workflow (recommended).
> If you choose a branch, the build artifacts will be uploaded to the `publish_branch` you pass as an input to the action, which defaults to `gh-pages`.
> If you choose a custom GitHub Actions workflow, you need to mention that in the input `publishing_source` to the action (this is made as default from v2). In this case, no branch will be created and the artifacts are deployed at run-time.
> [!TIP]
> Please find more information on configuring a publishing source for github pages site in the [official docs](https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site).

## Usage
Expand Down Expand Up @@ -99,7 +105,8 @@ This action helps in the automation of a deployment strategy mentioned in [platf

```

**NOTE:** From publish-kedro-viz@v2, we recommend you to choose a custom GitHub Actions workflow as a publishing source for GitHub Pages. No build artifacts will be pushed to a branch starting from publish-kedro-viz@v2.
> [!Important]
> From publish-kedro-viz@v2, we recommend you to choose a custom GitHub Actions workflow as a publishing source for GitHub Pages. No build artifacts will be pushed to a branch starting from publish-kedro-viz@v2.

2. With `kedro-org/publish-kedro-viz@v2`:

Expand Down Expand Up @@ -190,9 +197,9 @@ This action helps in the automation of a deployment strategy mentioned in [platf
After you've completed the configuration, trigger the workflow as per the workflow trigger condition.

- Once triggered, the GitHub workflow "Publish and share Kedro Viz" will automatically start and can be found in the Actions tab with your commit message.
- If your GitHub Pages publishing source is a branch, then the artifacts of your Kedro-Viz static site will be uploaded to the publish-branch input specified in the action upon successful completion of the workflow. Please note that starting v2, we will not upload artifacts to a branch. You can still use publishing source as a branch for GitHub Pages (not recommended) and make sure you follow the security considerations mentioned [here](https://github.com/actions/deploy-pages?tab=readme-ov-file#security-considerations).
- If your GitHub Pages publishing source is a custom GitHub Actions workflow (recommended), then the artifacts of your Kedro-Viz static site will be uploaded and deployed during the workflow run-time.
- You can access the static site at `http://<username>.github.io/<repo-name>`
- If your GitHub Pages publishing source is a branch, then the artifacts of your Kedro-Viz static site will be uploaded to the publish-branch input specified in the action upon successful completion of the workflow. Please note that starting v2, we will not upload artifacts to a branch. You can still use publishing source as a branch for GitHub Pages (not recommended) and make sure you follow the security considerations mentioned [here](https://github.com/actions/deploy-pages?tab=readme-ov-file#security-considerations).
- You can access the static site at `http://<username>.github.io/<repo-name>`, if your site's visibility is public. For more information on changing the visibility, you can follow the [official docs](https://docs.github.com/en/enterprise-cloud@latest/pages/getting-started-with-github-pages/changing-the-visibility-of-your-github-pages-site)

## Credits

Expand Down

0 comments on commit 21f975b

Please sign in to comment.