semantic-release plugin to publish a haskell package to Hackage
Semantic-release is widely used in the development world but have not been implemented for haskell projects and applications until now. This plugin is intended to help you create your candidate releases for a hackage package using the benefits of semantic-release
| Step | Description |
|---|---|
verifyConditions |
verify the environment variable HACKAGE_TOKEN |
prepare |
Update the version of .cabal file and create the distribution package (.tar) |
publish |
Publish the hackage package to the specified repository |
| Variable | Description | Required |
|---|---|---|
HACKAGE_TOKEN |
API token for hackage | true |
With npm:
npm install semantic-release-hackage -DWith yarn:
yarn add semantic-release-hackage --devThe plugin can be configured in the semantic-release configuration file. Here is a minimal example:
{
"plugins": [
"@semantic-release/commit-analyzer",
"@semantic-release/release-notes-generator",
[
"semantic-release-hackage",
{
"cabalFile": "yourcabalfilename",
"packageName": "yourpackagename",
"versionPrefix": "0.",
"publishDocumentation": true
}
]
]
}Based on the semantic-release philosophy, you don't need to keep track of the version in your repository (.cabal) anymore. The plugin will build the package with the proper version on the fly, making it simpler for you to maintain your packages. In simpler words, you can change your .cabal file to the following:
...
version: 0.0.0.0
...Note: Your Hackage release candidate is going to have the released version in the .cabal file.
If you still want to keep track of the version in the repository, you'll need to allow semantic-release to update your .cabal file in your repository after the semantic-release-hackage plugin finishes. This can be achieved with the @semantic-release/git plugin, but keep in mind that semantic-release explicitly discourages making commits during your release process.
Required: true
Description: Package name in Hackage.
Required: false
Description: Library cabal file name.
Default: The plugin will read your root .cabal file name.
Required: false
Description: Boolean value used for publishing release candidate documentation. When true the plugin will publish the documentation along with the candidate release.
Default: false
Required: false
Description: This is a version prefix created for supporting PVP versioning.
Default: ""
PVP is the standard versioning system for Haskell projects which is different from Semantic Versioning. You may think that since this is a semantic-release plugin, you'll have to move out from PVP. But thanks to the versionPrefix option, you can keep the 4th digit in your version.
This is an optional feature enabling PVP compatibility when using this plugin. So, if your package uses PVP, versionPrefix can save the day, and you can continue using PVP versioning with this amazing tool.
Keep in mind that using Semantic Versioning does make things simpler while following another well-known standard.
For example, if you have the version number 0.2.0.7 and want to create a new release for a new feature, semantic-release is going to infer the next version as 2.1.0, you can keep your previous versioning by adding the following to the plugin configuration:
"versionPrefix" : "0."
The plugin will add the 0. prefix to the new version, so your final version will be 0.2.1.0.
MIT, see the LICENSE file.
Do you want to contribute to this project? Please take a look at our contributing guideline to know how you can help us build it.
