shunjid / ux-reporter

(Part of research) CI/CD action that helps you prioritizing web issues along with the prediction of improvements your site is going to have after enhancement.

UX Reporter

CI/CD action that helps you prioritizing web issues along with prediction of improvements your site is going to have after following unit of issue improvement.

Usage

To use this GitHub Action you have to provide these information in your workflow yml. All the information are required.

• GC_TOKEN : API key for pagespeed insights.
• GH_TOKEN : GitHub provided personal access token.
• urls : Site urls you want to perform user experience prediction.
• splitter: Separator that separates your urls string into list of URL's. In example below comma ( , ) is the separator.

on: [push]

jobs:
  test_impact:
    runs-on: ubuntu-latest
    name: A job to test impact
    steps:
      - name: Checkout
        uses: actions/checkout@v2
      - name: UX Reporter
        uses: shunjid/ux-reporter@v1.1
        env:
          GC_TOKEN: ${{ secrets.GC_TOKEN }}
          GH_TOKEN: ${{ secrets.GH_TOKEN }}
        id: urls
        with:
          urls: 'https://shunjid.github.io,https://diu.edu.bd'
          splitter: ','

Output/Report

After successful completion, you can check report in a form of GitHub issue like below: