Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

add option ignoreFile to ignore file's contents like .gitignore

Open
  • Is something wrong?
#347 2 comments 8 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Start with the documentation referenced in the issue, then trace how configured assets are selected and committed. Define done as supporting an ignoreFile option that excludes matching contents and clarify whether the separate changed-files-only option is included; add coverage for the agreed behavior.

Written by the indexing model from the issue text.

Description

as mentioned in docs the commit will include everything in assets even if it is included in .gitignore.

you can add an option to ignore a file's contents like that

["@semantic-release/git", {
  assets: ["**/*.*"],
  ignoreFile= '.gitignore'
}]

this approach is used by many tools tile eslint and prettier

also, it is a good idea to add an option to include changed files only

Dominant language
JavaScript
Stars
340
Forks
75
Avg merge
4h 49m
Merged PRs (30d)
6

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

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.

More from semantic-release/git

All issues in semantic-release/git

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.