goutils

README

goutils

This repo is comprised of utilities that I use across various go projects.

Dependencies

• Install asdf:

  git clone https://github.com/asdf-vm/asdf.git ~/.asdf
  

• Install and use asdf plugins to manage go, python, and ruby for this project:

  source .asdf
  

  Alternatively, you can pick and choose which plugins to install:

  # Employ asdf for this project's python:
  source .asdf python
  

• Install pre-commit:

  python3 -m pip install --upgrade pip
  python3 -m pip install pre-commit
  

• Install Mage:

  go install github.com/magefile/mage@latest
  

• Install Keeper Commander:

  python3 -m pip install --upgrade pip
  python3 -m pip install keepercommander
  

---

For Contributors and Developers

1. Fork this project

2. Install dependencies:

   mage installDeps
   

3. Update and run pre-commit hooks locally:

   mage runPreCommit
   

---

Create New Release

• Download and install the gh cli tool:

  • macOS
  • Linux
  • Windows

• Install changelog extension:

  gh extension install chelnak/gh-changelog
  

• Generate changelog:

  NEXT_VERSION=v1.1.3
  gh changelog new --next-version "${NEXT_VERSION}"
  

• Create release:

  gh release create "${NEXT_VERSION}" -F CHANGELOG.md