GitHub Actions: paths-filter complete Guide

Table of Contents

Example 1 – Using paths-filter in Seprate file

	name: backend

	on:
	push:
	branches:
	- master
	pull_request:

	# Cancel in progress workflows on pull_requests.
	# https://docs.github.com/en/actions/using-jobs/using-concurrency#example-using-a-fallback-value
	concurrency:
	group: ${{ github.workflow }}-${{ github.head_ref \|\| github.run_id }}
	cancel-in-progress: true

	# hack for https://github.com/actions/cache/issues/810#issuecomment-1222550359
	env:
	SEGMENT_DOWNLOAD_TIMEOUT_MIN: 3

	jobs:
	files-changed:
	name: detect what files changed
	runs-on: ubuntu-20.04
	timeout-minutes: 3
	# Map a step output to a job output
	outputs:
	api_docs: ${{ steps.changes.outputs.api_docs }}
	backend: ${{ steps.changes.outputs.backend_all }}
	backend_dependencies: ${{ steps.changes.outputs.backend_dependencies }}
	backend_any_type: ${{ steps.changes.outputs.backend_any_type }}
	migration_lockfile: ${{ steps.changes.outputs.migration_lockfile }}
	plugins: ${{ steps.changes.outputs.plugins }}
	steps:
	- uses: actions/checkout@7884fcad6b5d53d10323aee724dc68d8b9096a2e # v2

	- name: Check for backend file changes
	uses: getsentry/paths-filter@66f7f1844185eb7fb6738ea4ea59d74bb99199e5 # v2
	id: changes
	with:
	token: ${{ github.token }}
	filters: .github/file-filters.yml

	api-docs:
	if: needs.files-changed.outputs.api_docs == 'true'
	needs: files-changed
	name: api docs test
	runs-on: ubuntu-20.04
	steps:
	- uses: actions/checkout@7884fcad6b5d53d10323aee724dc68d8b9096a2e # v2

	- uses: ./.github/actions/setup-volta

	- name: Setup sentry python env
	uses: ./.github/actions/setup-sentry
	id: setup
	with:
	snuba: true

	- name: Run API docs tests
	# install ts-node for ts build scripts to execute properly without potentially installing
	# conflicting deps when running scripts locally
	# see: https://github.com/getsentry/sentry/pull/32328/files
	run: \|
	yarn add ts-node && make test-api-docs

	backend-test:
	if: needs.files-changed.outputs.backend == 'true'
	needs: files-changed
	name: backend test
	runs-on: ubuntu-20.04
	timeout-minutes: 20
	strategy:
	# This helps not having to run multiple jobs because one fails, thus, reducing resource usage
	# and reducing the risk that one of many runs would turn red again (read: intermittent tests)
	fail-fast: false
	matrix:
	# XXX: When updating this, make sure you also update MATRIX_INSTANCE_TOTAL.
	instance: [0, 1, 2, 3]
	pg-version: ['9.6']

	env:
	# XXX: MATRIX_INSTANCE_TOTAL must be hardcoded to the length of strategy.matrix.instance.
	MATRIX_INSTANCE_TOTAL: 4
	MIGRATIONS_TEST_MIGRATE: 1

	steps:
	- uses: actions/checkout@7884fcad6b5d53d10323aee724dc68d8b9096a2e # v2
	with:
	# Avoid codecov error message related to SHA resolution:
	# https://github.com/codecov/codecov-bash/blob/7100762afbc822b91806a6574658129fe0d23a7d/codecov#L891
	fetch-depth: '2'

	- name: Setup sentry env
	uses: ./.github/actions/setup-sentry
	id: setup
	with:
	snuba: true
	# Right now, we run so few bigtable related tests that the
	# overhead of running bigtable in all backend tests
	# is way smaller than the time it would take to run in its own job.
	bigtable: true
	pg-version: ${{ matrix.pg-version }}

	- name: Run backend test (${{ steps.setup.outputs.matrix-instance-number }} of ${{ steps.setup.outputs.matrix-instance-total }})
	run: \|
	make test-python-ci

	- name: Handle artifacts
	uses: ./.github/actions/artifacts

	backend-test-in-silo-modes:
	needs: files-changed
	if: needs.files-changed.outputs.backend == 'true'
	&& (
	contains(github.head_ref, '/hc-')
	\|\| contains(github.head_ref, 'hybrid-cloud')
	)
	timeout-minutes: 60
	name: backend tests, hybrid cloud
	runs-on: ubuntu-20.04
	strategy:
	fail-fast: false
	matrix:
	# XXX: When updating this, make sure you also update MATRIX_INSTANCE_TOTAL.
	instance: [0, 1]
	pg-version: ['9.6']
	silo-mode:
	- CONTROL
	- REGION
	env:
	MATRIX_INSTANCE_TOTAL: 2
	MIGRATIONS_TEST_MIGRATE: 1
	SENTRY_SILO_MODE: ${{ matrix.silo-mode }}

	steps:
	- uses: actions/checkout@7884fcad6b5d53d10323aee724dc68d8b9096a2e # v2
	with:
	# Avoid codecov error message related to SHA resolution:
	# https://github.com/codecov/codecov-bash/blob/7100762afbc822b91806a6574658129fe0d23a7d/codecov#L891
	fetch-depth: '2'

	- name: Setup sentry env
	uses: ./.github/actions/setup-sentry
	id: setup
	with:
	snuba: true
	# Right now, we run so few bigtable related tests that the
	# overhead of running bigtable in all backend tests
	# is way smaller than the time it would take to run in its own job.
	bigtable: true
	pg-version: ${{ matrix.pg-version }}

	- name: Run backend test (${{ steps.setup.outputs.matrix-instance-number }} of ${{ steps.setup.outputs.matrix-instance-total }})
	run: \|
	make test-python-ci

	backend-test-snuba-contains-metrics-tag-values:
	if: needs.files-changed.outputs.backend == 'true'
	needs: files-changed
	name: backend test (snuba contains metrics tag values)
	runs-on: ubuntu-20.04
	timeout-minutes: 20
	strategy:
	# This helps not having to run multiple jobs because one fails, thus, reducing resource usage
	# and reducing the risk that one of many runs would turn red again (read: intermittent tests)
	fail-fast: false
	matrix:
	# XXX: When updating this, make sure you also update MATRIX_INSTANCE_TOTAL.
	instance: [0]
	pg-version: ['9.6']

	env:
	# XXX: MATRIX_INSTANCE_TOTAL must be hardcoded to the length of strategy.matrix.instance.
	MATRIX_INSTANCE_TOTAL: 1
	MIGRATIONS_TEST_MIGRATE: 1

	steps:
	- uses: actions/checkout@7884fcad6b5d53d10323aee724dc68d8b9096a2e # v2
	with:
	# Avoid codecov error message related to SHA resolution:
	# https://github.com/codecov/codecov-bash/blob/7100762afbc822b91806a6574658129fe0d23a7d/codecov#L891
	fetch-depth: '2'

	- name: Setup sentry env
	uses: ./.github/actions/setup-sentry
	id: setup
	with:
	snuba: true
	# Right now, we run so few bigtable related tests that the
	# overhead of running bigtable in all backend tests
	# is way smaller than the time it would take to run in its own job.
	bigtable: true
	pg-version: ${{ matrix.pg-version }}

	- name: Run backend test (${{ steps.setup.outputs.matrix-instance-number }} of ${{ steps.setup.outputs.matrix-instance-total }})
	run: \|
	export PYTEST_ADDOPTS="-m 'sentry_metrics and not broken_under_tags_values_as_strings'"
	export SENTRY_METRICS_SIMULATE_TAG_VALUES_IN_CLICKHOUSE=1
	make test-python-ci
	make test-snuba

	- name: Handle artifacts
	uses: ./.github/actions/artifacts

	cli:
	if: needs.files-changed.outputs.backend == 'true'
	needs: files-changed
	name: cli test
	runs-on: ubuntu-20.04
	timeout-minutes: 10
	strategy:
	matrix:
	pg-version: ['9.6']
	steps:
	- uses: actions/checkout@7884fcad6b5d53d10323aee724dc68d8b9096a2e # v2

	- name: Setup sentry env
	uses: ./.github/actions/setup-sentry
	id: setup
	with:
	pg-version: ${{ matrix.pg-version }}

	- name: Run test
	run: \|
	make test-cli

	- name: Handle artifacts
	uses: ./.github/actions/artifacts

	requirements:
	if: needs.files-changed.outputs.backend_dependencies == 'true'
	needs: files-changed
	name: requirements check
	runs-on: ubuntu-20.04
	timeout-minutes: 3
	steps:
	- uses: getsentry/action-github-app-token@38a3ce582e170ddfe8789f509597c6944f2292a9 # v1
	id: token
	continue-on-error: true
	with:
	app_id: ${{ secrets.SENTRY_INTERNAL_APP_ID }}
	private_key: ${{ secrets.SENTRY_INTERNAL_APP_PRIVATE_KEY }}
	- uses: actions/checkout@2541b1294d2704b0964813337f33b291d3f8596b # v3
	- uses: actions/setup-python@b4fe97ecda6b7a5fcd2448cdbf6a8fc76b3bedb0
	with:
	python-version: 3.8.13
	- name: check requirements
	run: \|
	python -m pip install -q "$(grep '^pip-tools==' requirements-dev-frozen.txt)"
	python -S -m tools.freeze_requirements sentry
	if ! git diff --exit-code; then
	echo $'\n\nrun `make freeze-requirements` locally to update requirements'
	exit 1
	fi
	- name: apply any requirements changes
	if: steps.token.outcome == 'success' && github.ref != 'refs/heads/master' && always()
	uses: getsentry/action-github-commit@1761f891f036c3efc813b2ba963b121120c1587a # main
	with:
	github-token: ${{ steps.token.outputs.token }}
	message: ':snowflake: re-freeze requirements'

	lint:
	if: needs.files-changed.outputs.backend == 'true'
	needs: files-changed
	name: backend lint
	runs-on: ubuntu-20.04
	timeout-minutes: 10
	steps:
	- uses: getsentry/action-github-app-token@38a3ce582e170ddfe8789f509597c6944f2292a9 # v1
	id: token
	continue-on-error: true
	with:
	app_id: ${{ secrets.SENTRY_INTERNAL_APP_ID }}
	private_key: ${{ secrets.SENTRY_INTERNAL_APP_PRIVATE_KEY }}

	- uses: actions/checkout@7884fcad6b5d53d10323aee724dc68d8b9096a2e # v2

	- uses: getsentry/paths-filter@66f7f1844185eb7fb6738ea4ea59d74bb99199e5 # v2
	id: files
	with:
	# Enable listing of files matching each filter.
	# Paths to files will be available in `${FILTER_NAME}_files` output variable.
	# Paths will be escaped and space-delimited.
	# Output is usable as command line argument list in linux shell
	list-files: shell

	# It doesn't make sense to lint deleted files.
	# Therefore we specify we are only interested in added or modified files.
	filters: \|
	all:
	- added\|modified: '*/.py'
	- added\|modified: 'requirements-*.txt'

	- uses: actions/setup-python@b4fe97ecda6b7a5fcd2448cdbf6a8fc76b3bedb0
	with:
	python-version: 3.8.13
	cache: pip
	cache-dependency-path: requirements-dev-only-frozen.txt

	- uses: actions/cache@56046cbc4743437ac40542086317b1561d7705f8 # v3.0.8
	with:
	path: ~/.cache/pre-commit
	key: cache-epoch-1\|${{ env.pythonLocation }}\|${{ hashFiles('.pre-commit-config.yaml') }}

	- name: Setup pre-commit
	# We don't use make setup-git because we're only interested in installing
	# requirements-dev-only-frozen.txt as a fast path.
	# We don't need pre-commit install --install-hooks since we're just interested
	# in running the hooks.
	run: \|
	pip install -r requirements-dev-only-frozen.txt
	pre-commit install-hooks

	- name: Run pre-commit on changed files
	run: \|
	# Run pre-commit to lint and format check files that were changed (but not deleted) compared to master.
	# XXX: there is a very small chance that it'll expand to exceed Linux's limits
	# `getconf ARG_MAX` - max # bytes of args + environ for exec()
	pre-commit run --files ${{ steps.files.outputs.all_files }}

	- name: Apply any pre-commit fixed files
	if: steps.token.outcome == 'success' && github.ref != 'refs/heads/master' && always()
	uses: getsentry/action-github-commit@1761f891f036c3efc813b2ba963b121120c1587a # main
	with:
	github-token: ${{ steps.token.outputs.token }}

	migration:
	if: needs.files-changed.outputs.migration_lockfile == 'true'
	needs: files-changed
	name: check migration
	runs-on: ubuntu-20.04
	strategy:
	matrix:
	pg-version: ['9.6']

	steps:
	- name: Checkout sentry
	uses: actions/checkout@7884fcad6b5d53d10323aee724dc68d8b9096a2e # v2

	- name: Setup sentry env
	uses: ./.github/actions/setup-sentry
	id: setup
	with:
	pg-version: ${{ matrix.pg-version }}

	- name: Migration & lockfile checks
	env:
	SENTRY_LOG_LEVEL: ERROR
	PGPASSWORD: postgres
	run: \|
	./.github/workflows/scripts/migration-check.sh

	plugins:
	if: needs.files-changed.outputs.plugins == 'true'
	needs: files-changed
	name: plugins test
	runs-on: ubuntu-20.04
	timeout-minutes: 10
	steps:
	- uses: actions/checkout@7884fcad6b5d53d10323aee724dc68d8b9096a2e # v2

	- name: Setup sentry env
	uses: ./.github/actions/setup-sentry
	id: setup
	with:
	snuba: true

	- name: Run test
	run: \|
	make test-plugins

	region-to-control:
	if: needs.files-changed.outputs.backend == 'true'
	needs: files-changed
	name: region-to-control test
	runs-on: ubuntu-20.04
	timeout-minutes: 20
	steps:
	- uses: actions/checkout@7884fcad6b5d53d10323aee724dc68d8b9096a2e # v2
	with:
	# Avoid codecov error message related to SHA resolution:
	# https://github.com/codecov/codecov-bash/blob/7100762afbc822b91806a6574658129fe0d23a7d/codecov#L891
	fetch-depth: '2'

	- name: Setup sentry env
	uses: ./.github/actions/setup-sentry
	id: setup
	with:
	kafka: true

	- name: Run test
	run: \|
	make test-region-to-control-integration

	- name: Handle artifacts
	uses: ./.github/actions/artifacts

	relay:
	if: needs.files-changed.outputs.backend == 'true'
	needs: files-changed
	name: relay test
	runs-on: ubuntu-20.04
	timeout-minutes: 20
	steps:
	- uses: actions/checkout@7884fcad6b5d53d10323aee724dc68d8b9096a2e # v2
	with:
	# Avoid codecov error message related to SHA resolution:
	# https://github.com/codecov/codecov-bash/blob/7100762afbc822b91806a6574658129fe0d23a7d/codecov#L891
	fetch-depth: '2'

	- name: Setup sentry env
	uses: ./.github/actions/setup-sentry
	id: setup
	with:
	snuba: true
	kafka: true

	- name: Pull relay image
	run: \|
	# pull relay we'll run and kill it for each test
	docker pull us.gcr.io/sentryio/relay:nightly
	docker ps -a

	- name: Run test
	run: \|
	make test-relay-integration

	- name: Handle artifacts
	uses: ./.github/actions/artifacts

	snuba:
	if: needs.files-changed.outputs.backend == 'true'
	needs: files-changed
	name: snuba test
	runs-on: ubuntu-20.04
	timeout-minutes: 30
	strategy:
	# This helps not having to run multiple jobs because one fails, thus, reducing resource usage
	# and reducing the risk that one of many runs would turn red again (read: intermittent tests)
	fail-fast: false
	matrix:
	# XXX: When updating this, make sure you also update MATRIX_INSTANCE_TOTAL.
	instance: [0, 1]
	env:
	# XXX: MATRIX_INSTANCE_TOTAL must be hardcoded to the length of strategy.matrix.instance.
	MATRIX_INSTANCE_TOTAL: 2
	MIGRATIONS_TEST_MIGRATE: 1

	steps:
	- uses: actions/checkout@7884fcad6b5d53d10323aee724dc68d8b9096a2e # v2
	with:
	# Avoid codecov error message related to SHA resolution:
	# https://github.com/codecov/codecov-bash/blob/7100762afbc822b91806a6574658129fe0d23a7d/codecov#L891
	fetch-depth: '2'

	- name: Setup sentry env
	uses: ./.github/actions/setup-sentry
	id: setup
	with:
	snuba: true
	kafka: true

	- name: Run snuba test (${{ steps.setup.outputs.matrix-instance-number }} of ${{ steps.setup.outputs.matrix-instance-total }})
	run: \|
	make test-snuba

	- name: Handle artifacts
	uses: ./.github/actions/artifacts

	symbolicator:
	if: needs.files-changed.outputs.backend == 'true'
	needs: files-changed
	name: symbolicator test
	runs-on: ubuntu-20.04
	timeout-minutes: 10
	steps:
	- uses: actions/checkout@7884fcad6b5d53d10323aee724dc68d8b9096a2e # v2
	with:
	# Avoid codecov error message related to SHA resolution:
	# https://github.com/codecov/codecov-bash/blob/7100762afbc822b91806a6574658129fe0d23a7d/codecov#L891
	fetch-depth: '2'

	- name: Setup sentry env
	uses: ./.github/actions/setup-sentry
	id: setup
	with:
	snuba: true
	kafka: true

	- name: Start symbolicator
	run: \|
	echo $PWD
	docker run \
	-d \
	-v $PWD/config/symbolicator/:/etc/symbolicator \
	--network host \
	--name symbolicator \
	us.gcr.io/sentryio/symbolicator:nightly \
	run -c /etc/symbolicator/config.yml
	docker ps -a

	- name: Run test
	run: \|
	make test-symbolicator

	- name: Handle artifacts
	uses: ./.github/actions/artifacts

	typing:
	if: needs.files-changed.outputs.backend == 'true'
	needs: files-changed
	name: backend typing
	runs-on: ubuntu-20.04
	timeout-minutes: 12
	steps:
	- uses: actions/checkout@7884fcad6b5d53d10323aee724dc68d8b9096a2e # v2

	- name: Setup Python
	uses: actions/setup-python@b4fe97ecda6b7a5fcd2448cdbf6a8fc76b3bedb0
	with:
	python-version: 3.8.13
	cache: pip
	cache-dependency-path: requirements-dev-frozen.txt

	# We don't call setup-sentry, because we don't need devservices.
	- name: Setup backend typing
	run: pip install -r requirements-dev-frozen.txt

	- name: Run backend typing (${{ steps.setup.outputs.matrix-instance-number }} of ${{ strategy.job-total }})
	run: make backend-typing

	# This check runs once all dependant jobs have passed
	# It symbolizes that all required Backend checks have succesfully passed (Or skipped)
	# This check is the only required Github check
	backend-required-check:
	needs:
	[
	api-docs,
	backend-test,
	cli,
	lint,
	requirements,
	migration,
	plugins,
	relay,
	region-to-control,
	snuba,
	symbolicator,
	typing,
	]
	name: Backend
	# This is necessary since a failed/skipped dependent job would cause this job to be skipped
	if: always()
	runs-on: ubuntu-20.04
	steps:
	# If any jobs we depend on fail, we will fail since this is a required check
	# NOTE: A timeout is considered a failure
	- name: Check for failures
	if: contains(needs..result, 'failure') \|\| contains(needs..result, 'cancelled')
	run: \|
	echo "One of the dependent jobs have failed. You may need to re-run it." && exit 1

view raw backend.yml hosted with

by GitHub

	# This is used by the action https://github.com/dorny/paths-filter (which we have forked to https://github.com/getsentry/paths-filter)

	# TODO: There are some meta files that we potentially could ignore for both front/backend,
	# as well as some configuration files that should trigger both
	frontend_components_lintable: &frontend_components_lintable
	- '*/.[tj]{s,sx}'

	frontend_lintable: &frontend_lintable
	- *frontend_components_lintable
	- '*/tsconfig.json'
	- '{package,now,vercel}.json'

	yarn_lockfile: &yarn_lockfile
	- 'yarn.lock'

	eslint_config: &eslint_config
	- '.eslint*'

	# `frontend_src` filters on files that are frontend changes excluding
	# changes to the tests/ directory.
	# If you want to filter on all frontend files, use the `frontend_all` filter.
	frontend_src: &frontend_src
	- *yarn_lockfile
	- *eslint_config
	- '!(tests)/*/.[tj]{s,sx}'
	- '*/tsconfig.json'
	- '{package,now,vercel}.json'
	- '*/.less'
	- 'docs-ui/**'
	- 'static/**'
	- 'fixtures/search-syntax/*/'
	- '.github/workflows/frontend.yml'

	frontend_all: &frontend_all
	- *frontend_src
	- '*/.[tj]{s,sx}'

	frontend_modified_lintable:
	- added\|modified: *frontend_lintable

	frontend_components_modified_lintable:
	- added\|modified: *frontend_components_lintable

	# Also used in `getsentry-dispatch.yml` to dispatch backend tests on getsentry
	backend_dependencies: &backend_dependencies
	- 'requirements-*.txt'

	backend_build_changes: &backend_build_changes
	# If you change this line make sure that workflows using this action (e.g. acceptance, api_docs)
	# and file-filters would be updated as well
	- '.github/actions/setup-sentry/action.yml'
	- '.github/workflows/backend.yml'
	- '.pre-commit-config.yaml'
	- 'Makefile'
	- 'pyproject.toml'

	# `backend_src` filters on files that are backend changes excluding
	# changes to the tests/ directory.
	# If you want to filter on all backend files, use the `backend_all` filter.
	backend_src: &backend_src
	- *backend_build_changes
	- *backend_dependencies
	- '!(tests)/*/.py'
	- '*/.sh'
	- '*/.pysnap'
	- 'src/sentry/!(static)/**'
	- 'migrations_lockfile.txt'
	- 'config/*/'
	- 'fixtures/search-syntax/*/'

	backend_all: &backend_all
	- *backend_src
	- '*/.py'
	- '*/.pyi'

	# This is the ultimate controller for acceptance.yml
	acceptance: &acceptance
	- *backend_all
	- *frontend_all
	# This is verbose because backend_build_changes includes it, however,
	- '.github/actions/setup-sentry/action.yml'
	- '.github/workflows/acceptance.yml'

	plugins: &plugins
	- *backend_all
	- 'src/sentry_plugins/*/.html'

	api_docs: &api_docs
	- *backend_all
	- 'api-docs/**'
	- 'tests/apidocs/**'

	# This is the ultimate controller for backend.yml
	backend_any_type: &backend_any_type
	- *backend_all
	- *api_docs
	- *plugins

	migrations_added:
	- added: 'src/sentry/migrations/*'

	migrations_modified:
	- modified: 'src/sentry/migrations/*'

	# These files will trigger our wokrflow to check if lockfile
	# updates are needed
	migration_lockfile:
	- *backend_dependencies
	- '*/.py'
	- .github/workflows/check-if-migration-is-required.yml
	- .github/workflows/scripts/migration-check.sh

view raw file-filters.yml hosted with

by GitHub

Example 2

  setup-env:
    runs-on: ${{ github.event.pull_request.user.login == 'dependabot[bot]' && 'arc-runners-dependabot' || 'arc-runners-platform' }}
    if: ${{ !contains(github.event.pull_request.labels.*.name, 'gha-skip-preclean') }}
    timeout-minutes: 20
    steps:
      - name: Clean environment
        run: |
          kubectl delete ns ${{ env.NAMESPACE }} || true

      - name: Checkout Platform
        uses: actions/checkout@v4
        with:
          ref: ${{ github.event.pull_request.head.sha }}
	
	  - name: Enable build based on the changes
	    uses: dorny/paths-filter@v3
        id: filter
        with:
          filters: |
            build:
              - 'cpp/**'
			  - 'docker/**'
			  - 'golang/**'
			  - 'jenkins/**'
			  - 'portal/**'
			  - 'supd2/**'
			  - 'tools/**'
			  - '!tools/dir1/**'
			  - '!tools/dir2/**'
			  - '!**/*.jpeg'
              - '!**/*.md'

Example 3

	name: Lint

	on: pull_request

	jobs:
	lint:
	name: Lint
	runs-on: ubuntu-latest
	env:
	NODE_OPTIONS: --max_old_space_size=4096
	steps:
	- name: Checkout
	uses: actions/checkout@v2
	with:
	fetch-depth: 1

	- name: Install
	run: npm ci

	# Checks to see if any files in the PR match one of the listed file types.
	# We can use this filter to decide whether or not to run linters or tests.
	# You can check if a file with a listed file type is in the PR by doing:
	# if: ${{ steps.filter.outputs.md == 'true' }}
	# This will return true if there's a markdown file that was changed
	# in the PR.
	- uses: dorny/paths-filter@v2.2.1
	id: filter
	with:
	filters: \|
	md:
	- '*/.md'
	js:
	- '*/.js'
	json:
	- '*/.json'
	scss:
	- '*/.scss'
	tags:
	- 'src/site/_data/i18n/tags.yml'

	# Use the filter to check if files with a specific file type were changed
	# in the PR. If they were, run the relevant linters. Otherwise, skip.

	- name: Lint Markdown
	if: ${{ steps.filter.outputs.md == 'true' }}
	run: npm run lint:md

	- name: Lint Tags
	if: ${{ steps.filter.outputs.tags == 'true' \|\| steps.filter.outputs.md == 'true' }}
	uses: ./.github/actions/lint-tags

	- name: Lint JavaScript
	if: ${{ steps.filter.outputs.js == 'true' \|\| steps.filter.outputs.json == 'true' }}
	run: npm run lint:js

	- name: Lint SCSS
	if: ${{ steps.filter.outputs.scss == 'true' }}
	run: npm run lint:scss

view raw lint-workflow.yml hosted with

by GitHub

Example 4

	name: python-linters

	on:
	push:
	branches:
	- main
	paths:
	- "**.py"
	pull_request:
	branches:
	- main
	paths:
	- "**.py"

	jobs:
	flake8-lint:
	runs-on: ubuntu-latest
	name: python linters
	steps:
	- name: Check out source repository
	uses: actions/checkout@v3
	- name: Set up Python environment
	uses: actions/setup-python@v4
	with:
	python-version: 3.8
	- name: Install linter dependencies
	run: \|
	python -m pip install pip==22.2.2
	pip install -r requirements-lint.txt
	- name: Check for python file changes
	uses: dorny/paths-filter@v2
	id: filter
	with:
	list-files: 'shell'
	filters: \|
	py_scripts_filter:
	- added\|modified: '*/.py'
	- name: Run linter
	if: ${{ steps.filter.outputs.py_scripts_filter == 'true' }}
	run: \|
	echo "Changed python files: ${{ steps.filter.outputs.py_scripts_filter_files }}"
	python -m flakeheaven lint ${{ steps.filter.outputs.py_scripts_filter_files }}
	python -m black --check ${{ steps.filter.outputs.py_scripts_filter_files }}
	python -m isort --check ${{ steps.filter.outputs.py_scripts_filter_files }}

view raw py_linter.yml hosted with

by GitHub

Example 5

https://gist.github.com/devops-school/9f911252a34f632ad96f10a8454b557d

Reference

https://github.com/dorny/paths-filter

Rajesh Kumar

I’m a DevOps/SRE/DevSecOps/Cloud Expert passionate about sharing knowledge and experiences. I am working at Cotocus. I blog tech insights at DevOps School, travel stories at Holiday Landmark, stock market tips at Stocks Mantra, health and fitness guidance at My Medic Plus, product reviews at I reviewed , and SEO strategies at Wizbrand.

Please find my social handles as below;

Rajesh Kumar Personal Website
Rajesh Kumar at YOUTUBE
Rajesh Kumar at INSTAGRAM
Rajesh Kumar at X
Rajesh Kumar at FACEBOOK
Rajesh Kumar at LINKEDIN
Rajesh Kumar at PINTEREST
Rajesh Kumar at QUORA
Rajesh Kumar at WIZBRAND

Upgrade & Secure Your Future with DevOps, SRE, DevSecOps, MLOps!

GitHub Actions: paths-filter complete Guide

Example 1 – Using paths-filter in Seprate file

Example 2

Example 3

Example 4

Example 5

Reference

Certification Courses

Need Assistance!!!

Feel Free To Contact Us

+1 (469) 756-6329

(US Call-WhatsApp)

+91 7004 215 841

(India Call-WhatsApp)

Email us

Contact@DevOpsSchool.com