semantic-release / semantic-release/commit-analyzer

feature request: option to filter commits by path

Open
#252 3 comments 10 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
448
Forks
82
Avg merge
17h 41m
Merged PRs (30d)
4

Description

Feature request

I'd like the option to be able to pass in a directory path or glob to filter commits by. For example, if I pass in ./src/, it should only read commits that touch the ./src/ directory.

Why?

  • Primarily, I think this would bring us one step closer to monorepo support. By running semantic-release in each sub-package with a commit-filter for its own directory, it would be able to determine whether to make a release for the subpackage.
  • Secondarily, setting a filter to source files can add an extra layer of protection in a large codebase.
  • Seems trivial to do

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing the commit-reading entry point in this JavaScript plugin and reviewing existing tests for commit analysis. Determine how a directory path or glob should be supplied, then verify that only commits touching the selected path are analyzed, including the ./src/ example. Confirm the behavior supports deciding whether a subpackage needs a release.

Written by the indexing model from the issue text.

Assessment

Tech stack
git, javascript
Domain
release
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.