Installations
npm install semantic-release-config-gitmojiDeveloper Guide
Typescript
Yes
Module System
CommonJS
Node Version
16.20.0
NPM Version
7.24.2
Score
52.9
Supply Chain
86.1
Quality
70.8
Maintenance
100
Vulnerability
95.8
License
Releases
conventional-changelog-gitmoji-config@1.5.2
Published on 12 Jun 2023
semantic-release-config-gitmoji@1.5.3
Published on 12 Jun 2023
semantic-release-config-gitmoji@1.5.2
Published on 10 Jun 2023
conventional-changelog-gitmoji-config@1.5.1
Published on 10 Jun 2023
semantic-release-config-gitmoji@1.5.1
Published on 10 Jun 2023
conventional-changelog-gitmoji-config@1.5.0
Published on 10 Jun 2023
Contributors
Unable to fetch Contributors
Languages
TypeScript (92.65%)
Handlebars (4.92%)
JavaScript (2.21%)
Shell (0.23%)
Developer
arvinxx
Download Statistics
Total Downloads
1,544,171
Last Day
685
Last Week
21,607
Last Month
134,721
Last Year
1,343,987
GitHub Statistics
226 Stars
643 Commits
27 Forks
3 Watching
2 Branches
10 Contributors
Bundle Size
5.95 kB
Minified
1.71 kB
Minified + Gzipped
Maintainers
Package Meta Information
Latest Version
1.5.3
Package Id
semantic-release-config-gitmoji@1.5.3
Unpacked Size
25.15 kB
Size
6.12 kB
File Count
16
NPM Version
7.24.2
Node Version
16.20.0
Publised On
12 Jun 2023
Total Downloads
Cumulative downloads
Total Downloads
1,544,171
Last day
-92.2%
685
Compared to previous day
Last week
-53.3%
21,607
Compared to previous week
Last month
-16.2%
134,721
Compared to previous month
Last year
696.4%
1,343,987
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
semantic-release-config-gitmoji
shareable semantic-release configuration for gitmoji commit style
How to use
Basic Usage
1// .releaserc.js 2module.exports = { 3 extends: ['semantic-release-config-gitmoji'], 4};
Create your config
use this in monorepo
1// .releaserc.js 2const { createConfig } = require('semantic-release-config-gitmoji/lib/createConfig'); 3 4const config = createConfig({ monorepo: true }); 5 6module.exports = config;
createConfig params
Common Options
| name | type | optional | default | description |
|---|---|---|---|---|
| releaseRules | ReleaseRule[] | true | n/a | |
| changelogTitle | string | true | # Changelog | |
| changelogFile | string | true | CHANGELOG.md |
Git Params
| name | type | optional | default | description |
|---|---|---|---|---|
| message | string | true | :bookmark: chore(release): ${nextRelease.gitTag} [skip ci]\n\n${nextRelease.notes} | The message for the release commit. See message. |
| gitAssets | false | string[] | ['CHANGELOG.md', 'package.json'] | Files to include in the release commit.Set to false to disable adding files to the release commit. See assets. |
Github Params
| name | type | optional | default | description |
|---|---|---|---|---|
| enableGithub | boolean | true | true | 开启 github 插件 |
NPM Params
| name | type | optional | default | description |
|---|---|---|---|---|
| enableNPM | boolean | true | true | 开启 npm 插件 |
| npmPublish | boolean | true | n/a | Whether to publish the npm package to the registry. If false the package.json version will still be updated. false if the package.json private property is true, true otherwise |
| pkgRoot | string | true | n/a | Directory path to publish. default: . |
| tarballDir | string | false | true | n/a |
| monorepo | boolean | true | n/a | 如果是 Monorepo 仓库发布 npm 包，使用 "@semrel-extra/npm" 替代官方包 if using monorepo, use "@semrel-extra/npm" instead of the official package |
GithubPluginOpts
| name | type | optional | default | description |
|---|---|---|---|---|
| githubUrl | string | true | GH_URL or GITHUB_URL environment variable. | The GitHub Enterprise endpoint. |
| githubApiPathPrefix | string | true | GH_PREFIX or GITHUB_PREFIX environment variable. | The GitHub Enterprise API prefix. |
| githubAssets | string[] | true | - | An array of files to upload to the release. See assets. |
| proxy | string | true | HTTP_PROXY environment variable. | The proxy to use to access the GitHub API. See proxy. |
| successComment | string | true | :tada: This issue has been resolved in version ${nextRelease.version} :tada: | The release is available on GitHub release The assignees to add to the issue created when a release fails. |
License
MIT ® Arvin Xu
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
0 existing vulnerabilities detected
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
Found 2/30 approved changesets -- score normalized to 0
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/release.yml:1
- Warn: no topLevel permission defined: .github/workflows/test.yml:1
- Info: no jobLevel write permissions found
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/arvinxx/gitmoji-commit-workflow/release.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/arvinxx/gitmoji-commit-workflow/release.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/arvinxx/gitmoji-commit-workflow/release.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:40: update your workflow using https://app.stepsecurity.io/secureworkflow/arvinxx/gitmoji-commit-workflow/release.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:43: update your workflow using https://app.stepsecurity.io/secureworkflow/arvinxx/gitmoji-commit-workflow/release.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:48: update your workflow using https://app.stepsecurity.io/secureworkflow/arvinxx/gitmoji-commit-workflow/release.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:8: update your workflow using https://app.stepsecurity.io/secureworkflow/arvinxx/gitmoji-commit-workflow/test.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/test.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/arvinxx/gitmoji-commit-workflow/test.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/arvinxx/gitmoji-commit-workflow/test.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/test.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/arvinxx/gitmoji-commit-workflow/test.yml/master?enable=pin
- Warn: npmCommand not pinned by hash: .github/workflows/release.yml:56
- Info: 0 out of 6 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 4 third-party GitHubAction dependencies pinned
- Info: 0 out of 1 npmCommand dependencies pinned
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 3 are checked with a SAST tool
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'master'
Score
3.4
/10
Last Scanned on 2025-01-27
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More