pavi2410 / html-preview-action

GitHub action to preview HTML page

HTML Preview Action

This is a simple Github Action which comments on your PRs with a link to preview HTML files directly in the browser.

This is just a novelty action, but feel free to use it. If you'd like to contribute then just open a PR.

Usage

- name: HTML Preview
  id: html_preview
  uses: pavi2410/html-preview-action@v2
  with:
    html_file: 'index.html'

To get the url output, use this steps.html_preview.outputs.url in your later steps.

Credits

https://github.com/htmlpreview/htmlpreview.github.com

html-preview-action's Issues

proper documentation

can we please get proper documentation on how to use?

Getting ##[error]Cannot read property 'number' of undefined

Hi, tried using your code for github actions via marketplace, getting the following error while trying to build and run my html. Have you encountered the same?

Run pavi2410/html-preview-action@v1a
with:
msg: Click here to preview HTML page in browser
html_file: docs/html/index.html
gh_token: ***

##[error]Cannot read property 'number' of undefined

What is the file/info needed here?

What is the file/info needed here? I dont know if my container has it.

404 Not Found

I am trying to use your tool to display my test result.
I like the PR comment functionality so I am using your v1a.
It passes the Publish test results step but then I get a 404 when clicking on the link:

Any pointers?

Here is my workflow:

env:
  PYTHON: /usr/bin/python3
  WORKING_DIR: /home/runner/work/surface-tmp/surface-tmp
  VENV: /home/runner/work/surface-tmp/surface-tmp/.env/bin
  PYSPARK_PYTHON: python3
  PYSPARK_DRIVER_PYTHON: python3

name: Surface

on:
  pull_request:
    branches:
      - master

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@master
      - name: Cache pip
        uses: actions/cache@v2
        with:
          path: ~/.cache/pip
          key: ${{ runner.os }}-pip-${{ hashFiles('requirements.txt') }}
          restore-keys: |
            ${{ runner.os }}-pip-
            ${{ runner.os }}-
      - name: Test
        run: |
          ${PYTHON} -m venv .env
          ${VENV}/pip install -r ${WORKING_DIR}/requirements.txt
          ${VENV}/python test_report.py --open_browser False
      - name: Publish test results
        id: html_preview
        uses: pavi2410/html-preview-action@v1a
        with:
          msg: 'Click here to open test result in browser'
          html_file: 'reports/surface-test-report.html'