GitHub Action
CodeTour Watch
v3.0.0
Latest version
A GitHub action that flags file changes in a PR that may affect CodeTour content.
The action comments on the PR to report changes that may impact CodeTour:
The action will not comment the PR if changes do not impact CodeTour.
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@v1.6.3
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}| 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 |
| 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. |