versioner

Version: 0.1.3

Versioner is a basic utility to help keep a repo's version in sync and updated across various files

Installation

1. Add the dependency to your shard.yml:

   dependencies:
     versioner:
       github: drhuffman12/versioner
   

2. Run shards install

Usage

require "versioner"

TODO: Write usage instructions here

Development

TODO: Write development instructions here

Contributing

1. FORK it (https://github.com/drhuffman12/versioner/fork)
2. Make sure you are on the main/master BRANCH (git branch git reset --hard; git checkout master; git pull origin master)
3. Create your FEATURE branch (git checkout -b my-new-feature)
4. TEST existing changes!!! (crystal spec --error-trace)
5. VERIFY your "Changes to be committed" (git status)
6. ADD your CHANGES (git add my-new-files)
7. TEST your changes!!! (crystal spec --error-trace)
8. Run AUTOFORMATTING (crystal tool format, bin/ameba)
9. AUTOBUMP the version of your changes!!! (crystal src/versioner/ver_auto_bump.cr, or from your app: crystal lib/versioner/src/versioner/ver_auto_bump.cr)
10. *** (Please) correctly update the VERSION!!! (Edit/Syncup README.md and shard.yml)
11. Git add your updated your changes (git add README.md; git add shard.yml)

• You can check the version updated in the README.yml and the shard.yml files.

12. COMMIT your changes to your new branch (git commit -am 'my-new-feature description')
13. PUSH to the branch (git push origin my-new-feature)
14. BEFORE you merge the branch, confim locally via: Run the BUILD (act -j build)
15. Create a new Pull Request, get it Approved, and Merge it!

Contributors

• Daniel Huffman - creator and maintainer