https://github.com/pozil/codetour-watch

GitHub Action that flags file changes that may affect CodeTour content
https://github.com/pozil/codetour-watch

action codetour comment pr tour

Last synced: about 1 year ago
JSON representation

GitHub Action that flags file changes that may affect CodeTour content

• Host: GitHub
• URL: https://github.com/pozil/codetour-watch
• Owner: pozil
• License: cc0-1.0
• Created: 2020-08-22T19:24:38.000Z (almost 6 years ago)
• Default Branch: v3
• Last Pushed: 2025-04-02T12:17:57.000Z (about 1 year ago)
• Last Synced: 2025-05-06T17:48:33.528Z (about 1 year ago)
• Topics: action, codetour, comment, pr, tour
• Language: JavaScript
• Homepage:
• Size: 36 MB
• Stars: 16
• Watchers: 2
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
[![GitHub Marketplace](https://img.shields.io/badge/Marketplace-CodeTour%20Watch-blue.svg?colorA=24292e&colorB=0366d6&style=flat&longCache=true&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAAOCAYAAAAfSC3RAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAM6wAADOsB5dZE0gAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAAERSURBVCiRhZG/SsMxFEZPfsVJ61jbxaF0cRQRcRJ9hlYn30IHN/+9iquDCOIsblIrOjqKgy5aKoJQj4O3EEtbPwhJbr6Te28CmdSKeqzeqr0YbfVIrTBKakvtOl5dtTkK+v4HfA9PEyBFCY9AGVgCBLaBp1jPAyfAJ/AAdIEG0dNAiyP7+K1qIfMdonZic6+WJoBJvQlvuwDqcXadUuqPA1NKAlexbRTAIMvMOCjTbMwl1LtI/6KWJ5Q6rT6Ht1MA58AX8Apcqqt5r2qhrgAXQC3CZ6i1+KMd9TRu3MvA3aH/fFPnBodb6oe6HM8+lYHrGdRXW8M9bMZtPXUji69lmf5Cmamq7quNLFZXD9Rq7v0Bpc1o/tp0fisAAAAASUVORK5CYII=)](https://github.com/marketplace/actions/codetour-watch)

# CodeTour Watch

A GitHub action that flags file changes in a PR that may affect [CodeTour content](https://marketplace.visualstudio.com/items?itemName=vsls-contrib.codetour).

The action comments on the PR to report changes that may impact CodeTour:

![Screenshot of comment](docs/comment-screenshot.png)

The action will not comment the PR if changes do not impact CodeTour.

## Usage

```yml

name: CodeTour watch

on:

    pull_request:

        types: [opened, edited, synchronize, reopened]

jobs:

    codetour-watch:

        runs-on: ubuntu-latest

        steps:

            - name: 'Checkout source code'

              uses: actions/checkout@v3

            - name: 'Watch CodeTour changes'

              uses: pozil/codetour-watch@v3.0.0

              with:

                  repo-token: ${{ secrets.GITHUB_TOKEN }}

```

## Inputs

| Name                           | Required | Description                                                                                | Default                |

| ------------------------------ | -------- | ------------------------------------------------------------------------------------------ | ---------------------- |

| `repo-token`                   | false    | The GITHUB_TOKEN, required to comment.                                                     | `secrets.GITHUB_TOKEN` |

| `silent`                       | false    | Optional flag that turns off the comment on the PR.                                        | `false`                |

| `tour-path`                    | false    | Optional parameter that specifies a custom `.tours` folder location.                       | `.tours`               |

| `fail-on-missing-tour-updates` | false    | Optional flag that forces the action to fail when update tour files are missing from a PR. | `false`                |

## Outputs

| Name                 | Description                                                                          |

| -------------------- | ------------------------------------------------------------------------------------ |

| `impactedFiles`      | The list of files covered by tours that were changed.                                |

| `impactedTours`      | The list of tours that were impacted by the PR.                                      |

| `missingTourUpdates` | The list of tours that were impacted by the changes but that are not part of the PR. |