Settings assets to false results in error

Open
#280 2 comments 7 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
35/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Stale
Tech stack
git, javascript
Domain
release

Research direction

Start with @semantic-release/git/lib/prepare.js, the file named in the stack trace, and compare its assets handling with the documented false setting. Reproduce the issue using the shown .releaserc.js configuration; done means this configuration no longer throws assets.map is not a function and its behavior matches the documentation.

Written by the indexing model from the issue text.

Description

With this .releaserc.js:

module.exports = {
  branches: ["main"],
  plugins: [
    "@semantic-release/commit-analyzer", // analyzes commits with conventional-changelog standrd
    "@semantic-release/release-notes-generator", // generates changelog content based on conventional-changelog standard
    "@semantic-release/changelog", // updates CHANGELOG.md
    "@semantic-release/npm", // updates version in package.json based on commits
    ["@semantic-release/git", { assets: false }],
  ],
};

I get this error:

[3:43:47 PM] [semantic-release] › ✖  An error occurred while running semantic-release: TypeError: assets.map is not a function
--
130 | at module.exports (/codebuild/output/src038058146/src/git-codecommit.us-east-1.amazonaws.com/v1/repos/gb-static-site/node_modules/@semantic-release/git/lib/prepare.js:37:14)
131 | at processTicksAndRejections (internal/process/task_queues.js:93:5)
132 | at async prepare (/codebuild/output/src038058146/src/git-codecommit.us-east-1.amazonaws.com/v1/repos/gb-static-site/node_modules/@semantic-release/git/index.js:28:3)
133 | at async validator (/codebuild/output/src038058146/src/git-codecommit.us-east-1.amazonaws.com/v1/repos/gb-static-site/node_modules/semantic-release/lib/plugins/normalize.js:34:24)
134 | at async /codebuild/output/src038058146/src/git-codecommit.us-east-1.amazonaws.com/v1/repos/gb-static-site/node_modules/semantic-release/lib/plugins/pipeline.js:37:34
135 | at async /codebuild/output/src038058146/src/git-codecommit.us-east-1.amazonaws.com/v1/repos/gb-static-site/node_modules/semantic-release/lib/plugins/pipeline.js:31:3
136 | at async Object.pluginsConf.<computed> [as prepare] (/codebuild/output/src038058146/src/git-codecommit.us-east-1.amazonaws.com/v1/repos/gb-static-site/node_modules/semantic-release/lib/plugins/index.js:80:11)
137 | at async run (/codebuild/output/src038058146/src/git-codecommit.us-east-1.amazonaws.com/v1/repos/gb-static-site/node_modules/semantic-release/index.js:185:3)
138 | at async module.exports (/codebuild/output/src038058146/src/git-codecommit.us-east-1.amazonaws.com/v1/repos/gb-static-site/node_modules/semantic-release/index.js:260:22)
139 | at async module.exports (/codebuild/output/src038058146/src/git-codecommit.us-east-1.amazonaws.com/v1/repos/gb-static-site/node_modules/semantic-release/cli.js:55:5) {
140 | pluginName: '@semantic-release/git'
141 | }
142 | TypeError: assets.map is not a function
143 | at module.exports (/codebuild/output/src038058146/src/git-codecommit.us-east-1.amazonaws.com/v1/repos/gb-static-site/node_modules/@semantic-release/git/lib/prepare.js:37:14)
144 | at processTicksAndRejections (internal/process/task_queues.js:93:5)
145 | at async prepare (/codebuild/output/src038058146/src/git-codecommit.us-east-1.amazonaws.com/v1/repos/gb-static-site/node_modules/@semantic-release/git/index.js:28:3)
146 | at async validator (/codebuild/output/src038058146/src/git-codecommit.us-east-1.amazonaws.com/v1/repos/gb-static-site/node_modules/semantic-release/lib/plugins/normalize.js:34:24)
147 | at async /codebuild/output/src038058146/src/git-codecommit.us-east-1.amazonaws.com/v1/repos/gb-static-site/node_modules/semantic-release/lib/plugins/pipeline.js:37:34
148 | at async /codebuild/output/src038058146/src/git-codecommit.us-east-1.amazonaws.com/v1/repos/gb-static-site/node_modules/semantic-release/lib/plugins/pipeline.js:31:3
149 | at async Object.pluginsConf.<computed> [as prepare] (/codebuild/output/src038058146/src/git-codecommit.us-east-1.amazonaws.com/v1/repos/gb-static-site/node_modules/semantic-release/lib/plugins/index.js:80:11)
150 | at async run (/codebuild/output/src038058146/src/git-codecommit.us-east-1.amazonaws.com/v1/repos/gb-static-site/node_modules/semantic-release/index.js:185:3)
151 | at async module.exports (/codebuild/output/src038058146/src/git-codecommit.us-east-1.amazonaws.com/v1/repos/gb-static-site/node_modules/semantic-release/index.js:260:22)
152 | at async module.exports (/codebuild/output/src038058146/src/git-codecommit.us-east-1.amazonaws.com/v1/repos/gb-static-site/node_modules/semantic-release/cli.js:55:5) {
153 | pluginName: '@semantic-release/git'
154 | }

Is the documentation wrong? Docs say I should be able to set assets to false.

Dominant language
JavaScript
Stars
339
Forks
75
Avg merge
5h 15m
Merged PRs (30d)
6

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.

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.