haspara

Note: This software is under development and of prototype quality at the moment. Expect significant breaking changes without notification until we reach the first minor version. Until then, we will keep bumping the patch version.

haspara is a Haskell library that provides monetary definitions and a rudimentary (and experimental) accounting functionality.

Development

Before committing code to repository, reformat the code:

stylish-haskell -i -r src/

Compile the codebase, check warnings and errors:

stack test
stack build
stack haddock

Run hlint:

hlint src/

Run weeder:

weeder --require-hs-files

Making Releases

1. Switch to develop branch:

   git checkout develop
   

2. Ensure that your development branch is up to date:

   git pull
   

3. Checkout main branch:

   git checkout main
   

4. Merge develop branch to main:

   git merge --no-ff develop
   

5. Update the version information in package.yaml if required and recompile the project to reflect the change on the .cabal file:

   stack build
   

6. Update CHANGELOG.md file:

   git-chglog --next-tag <NEW-VERSION> -o CHANGELOG.md
   

7. Commit, tag and push:

   git commit -am "chore(release): <NEW-VERSION>"
   git tag -a -m "Release <NEW-VERSION>" <NEW-VERSION>
   git push --follow-tags origin main
   

8. Release to Hackage as a candidate first and check the result:

   stack upload --candidate .
   

9. If the candidate package release works fine, release to Hackage:

   stack upload .
   

10. Checkout to develop and rebase onto main:

    git checkout develop
    git rebase main
    

11. Update the version information in package.yaml with the upcoming version and recompile the project to reflect the change on the .cabal file:

    stack build
    

12. Commit and push:

    git commit -am "chore: bump development version to <UPCOMING-VERSION>"
    git push
    

License

Copyright Telostat Pte Ltd (c) 2021-2022.

This work is licensed under MIT license. See LICENSE.