Skip to content

DEVELOPMENT.md

Latest commit

 

History

History
54 lines (36 loc) · 1.18 KB

DEVELOPMENT.md

File metadata and controls

54 lines (36 loc) · 1.18 KB

Development

Cronedit is written in C++/C and without external dependencies. Supported platforms are debian and MacOS.

How to develop locally

Clone the repository:

git clone [email protected]:codeclown/cronedit.git
cd cronedit/

Run tests:

make test

Build binaries (written into bin/):

make build

Run the build:

./bin/cronedit lib/sample.txt

Release process

CI builds

For each commit and pull request, GitHub Actions is used to automatically build binaries on:

  • Ubuntu 18.04
  • MacOS 10.15 (Catalina)

The resulting binaries are uploaded as artifacts into the respective GitHub workflow.

See .github/workflows/build.yml.

Making a release

  1. Bump the version in lib/version.h, e.g. #define CRONEDIT_VERSION "0.1.1"
  2. Update CHANGELOG.md
  3. Make a commit and git push
  4. Add a git tag, e.g. git tag v0.1.1
  5. Push with tags git push --tags
  6. GitHub action detects the new tag and creates a draft release with attached binaries. Review and publish it here: https://github.com/codeclown/cronedit/releases
  7. Update latest binary download URLs in README.md