Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
book

GitHub Action

CodeTour Watch

v1.3.0

CodeTour Watch

book

CodeTour Watch

Flags file changes that may affect CodeTour content

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: CodeTour Watch

              
  uses: pozil/codetour-watch@v1.3.0
Learn more about this action in pozil/codetour-watch

Choose a version

GitHub Marketplace

CodeTour Watch

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:

Screenshot of comment

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

Usage

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@v2
        
            - name: 'Watch CodeTour changes'
              uses: pozil/codetour-watch@v1.2.0
              with:
                  repo-token: ${{ secrets.GITHUB_TOKEN }}

Inputs

Name Required Description Default
repo-token true The GITHUB_TOKEN, required to comment.
silent false Optional flag that turns off the comment on the PR. false
tour-path false Optional flag that specifies a custom .tours folder location. .tours

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.