{"_id":"@duell10111/semantic-release-calver","name":"@duell10111/semantic-release-calver","dist-tags":{"latest":"0.2.2"},"versions":{"0.2.2":{"name":"@duell10111/semantic-release-calver","version":"0.2.2","main":"dist/index.js","types":"dist/index.d.ts","license":"MIT","scripts":{"build":"tsc","test":"jest","test:report":"jest --coverage --outputFile=test-reports/results.xml --reporters=jest-junit","prepare":"npm run build","release":"semantic-release"},"description":"Semantic-Release plugin for versioning using CalVer spec.","keywords":["semantic-release","calver","version","versioning"],"author":{"name":"@mrbernnz","email":"noel.agaille@gmail.com"},"repository":{"type":"git","url":"git+https://github.com/mrbernnz/semantic-release-calver.git"},"peerDependencies":{"date-fns":"^2.30.0","semantic-release":"^19.0.0"},"devDependencies":{"@babel/core":"7.26.0","@babel/preset-env":"7.26.0","@babel/preset-typescript":"7.26.0","@semantic-release/github":"11.0.1","@semantic-release/npm":"12.0.1","@types/jest":"29.5.14","@types/node":"22.10.2","@types/semantic-release":"20.0.6","@types/semantic-release__error":"3.0.3","@types/signale":"1.4.7","babel-jest":"29.7.0","date-fns":"4.1.0","jest":"29.7.0","jest-junit":"16.0.0","semantic-release":"24.2.0","semver":"7.6.3","signale":"1.4.0","ts-jest":"29.2.5","typescript":"5.7.2"},"directories":{"test":"tests"},"release":{"branches":["main",{"name":"beta","prerelease":true},{"name":"alpha","prerelease":true}]},"bugs":{"url":"https://github.com/mrbernnz/semantic-release-calver/issues"},"homepage":"https://github.com/mrbernnz/semantic-release-calver#readme","_id":"@duell10111/semantic-release-calver@0.2.2","gitHead":"9dd04bf2f524c4aeafed301d00630c73189f5b21","_nodeVersion":"24.2.0","_npmVersion":"11.3.0","dist":{"integrity":"sha512-2R6HM4pwnPE+CacsjsiE3F/hJVPUlqTkaubp0A4hklwPG20AGHmFg3qdRHhUKI/UAEWLSIXyEij1mIEU7pUF5w==","shasum":"e52778626dea1c420589242bc3b7558afed062de","tarball":"https://registry.npmjs.org/@duell10111/semantic-release-calver/-/semantic-release-calver-0.2.2.tgz","fileCount":6,"unpackedSize":8872,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIQCz+FHY4aS2AkDd2mji136yQPz02m9GbbtrvjXTNEyNIwIgMaRYeuxtu8GIahDbtWYH5m1jEpVIoBqb/T1LBEtntVQ="}]},"_npmUser":{"name":"duell10111","email":"duell10111@t-online.de"},"maintainers":[{"name":"duell10111","email":"duell10111@t-online.de"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/semantic-release-calver_0.2.2_1750071476982_0.6077336797301542"},"_hasShrinkwrap":false}},"time":{"created":"2025-06-16T10:57:56.843Z","0.2.2":"2025-06-16T10:57:57.160Z","modified":"2025-06-16T10:57:57.474Z"},"maintainers":[{"name":"duell10111","email":"duell10111@t-online.de"}],"description":"Semantic-Release plugin for versioning using CalVer spec.","homepage":"https://github.com/mrbernnz/semantic-release-calver#readme","keywords":["semantic-release","calver","version","versioning"],"repository":{"type":"git","url":"git+https://github.com/mrbernnz/semantic-release-calver.git"},"author":{"name":"@mrbernnz","email":"noel.agaille@gmail.com"},"bugs":{"url":"https://github.com/mrbernnz/semantic-release-calver/issues"},"license":"MIT","readme":"# @mrbernnz/semantic-release-calver\n\nA plugin for semantic-release that supports Calendar Versioning ([CalVer](https://calver.org)) for automated release management. CalVer uses date-based versioning, making it ideal for projects with frequent releases.\n\n## Features\n\n- 📅 CalVer Support: Adheres to the Calendar Versioning format (e.g. YYYY.MM.MINOR).\n- 🔧 Flexible Configuration: Customize versioning patterns to fit your project needs.\n- ✅ Integration Ready: Works seamlessly with semantic-release workflows.\n- ⚙️ TypeScript Support: Fully typed for better developer experience.\n- 🔒 Secure and Reliable: Built with best practices for automated release pipelines.\n\n## Installation\n\nInstall the package via npm or yarn:\n\n```sh\n# Using npm\nnpm install @mrbernnz/semantic-release-calver --save-dev\n\n# Using yarn\nyarn add @mrbernnz/semantic-release-calver --dev\n```\n\n## Usage\n\n### Basic Setup\n\nTo use semantic-release-calver, configure it as a plugin in your release configuration file (e.g., release.config.js):\n\n```js\nmodule.exports = {\n  branches: ['main'],\n  plugins:\n    '@semantic-release/release-notes-generator',\n    '@semantic-release/changelog',\n    '@semantic-release/git',\n    '@semantic-release/npm',\n    '@mrbernnz/semantic-release-calver'\n\n};\n```\n\n### Example Release Workflow\n\nWith the configuration above, semantic-release-calver will:\n\n1. Generate a version in the specified CalVer format.\n2. Automatically create and publish releases using semantic-release.\n\n## API Reference\n\n@mrbernnz/semantic-release-calver plugin\n\n### Returns\n\nA string representing the calculated version (e.g., 2024.01.0).\n\nExample\n\n```js\nconst calverPlugin = require('@mrbernnz/semantic-release-calver');\n\nconst version = calverPlugin.calculateNextVersion({\n  lastVersion: '2023.12.2'\n});\n\nconsole.log(version); // Outputs: '2024.01.0'\n```\n\n## Integration Examples\n\nGitHub Actions\n\nHere’s an example workflow to use semantic-release-calver in a GitHub Actions pipeline:\n\n```yaml\nname: Release\n\non:\npush:\nbranches: - main\n\njobs:\nrelease:\nruns-on: ubuntu-latest\nsteps: - name: Checkout repository\nuses: actions/checkout@v3 - name: Set up Node.js\nuses: actions/setup-node@v3\nwith:\nnode-version: 16 - name: Install dependencies\nrun: npm install - name: Run semantic-release\nrun: npx semantic-release\nenv:\nGITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\nNPM_TOKEN: ${{ secrets.NPM_TOKEN }}\n```\n\n## Troubleshooting Guide\n\n### Common Issues\n\n1. Plugin Not Executing:\n   - Verify that the plugin is correctly configured in the plugins array of your release.config.js.\n2. Authentication Errors:\n   - Ensure you’ve set the necessary environment variables (GITHUB_TOKEN, GITLAB_TOKEN, NPM_TOKEN).\n\n## Contributing\n\nContributions are welcome to semantic-release-calver! Please follow these steps:\n\n1. Fork the repository and clone it locally.\n2. Create a feature branch:\n\n```sh\ngit checkout -b feature/my-feature\n```\n\n3. Commit your changes:\n\n```sh\ngit commit -m \"Add my feature\"\n```\n\n4. Push to your fork and submit a pull request.\n\n## License\n\nThis project is licensed under the MIT License.\n","readmeFilename":"README.md","_rev":"1-75b3c76e586587078843e7917daf1f2a"}