Watch
1
0
Fork
You've already forked pondi
0
mirror of https://github.com/restic/pondi.git synced 2026-11-17 03:10:54 +00:00
Release helper tool for restic and related projects
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
Alexander Neumann 25db6f476d Add Actions
2020-07-19 17:22:35 +02:00
.github/workflows Add Actions 2020-07-19 17:22:35 +02:00
.vscode Add word to spell file 2020-05-30 15:20:38 +02:00
.gitignore Scaffolding 2020-05-24 16:04:42 +02:00
.pondi.yml Add checks 2020-05-24 17:18:10 +02:00
checks.go Remove debug 2020-05-30 15:15:50 +02:00
cmd_check.go Add check for version tag 2020-05-27 21:46:09 +02:00
cmd_hooks.go Run check for uncommitted changes before hooks 2020-05-30 15:26:39 +02:00
config.go Add checks 2020-05-24 17:18:10 +02:00
go.mod Add checks 2020-05-24 17:18:10 +02:00
go.sum Add checks 2020-05-24 17:18:10 +02:00
hooks.go Run check for uncommitted changes before hooks 2020-05-30 15:26:39 +02:00
LICENSE Scaffolding 2020-05-24 16:04:42 +02:00
main.go Add command hooks 2020-05-24 17:39:51 +02:00
multi_error.go Add error handling to checks 2020-05-24 17:52:11 +02:00
README.md Add Docker 2020-05-27 21:49:14 +02:00

Introduction

Pondi is a helper tool to build release assets (binaries, source code archive), create a release on GitHub and upload the files. It is specifically tailored to the programming language Go and the style and requirements tools around the restic backup program have.

Goals (what pondi should do once it's finished):

  • Generate a changelog file using calens
  • Update the version in the source code as well as the VERSION file (if it exists)
  • Create a new release tag (if it does not exist yet)
  • Build binaries for all architectures and OS, in a reproducible way
  • Create tar.gz files for each architecture/OS
  • Build a source archive
  • Create a SHA256SUMS of all created files and and sign it
  • Generate release notes using calens
  • Create a release on GitHub with the generated release notes and upload the assets
  • Build and push Docker images

The program should be idempotent, so if you re-run pondi it should continue where it left of instead of starting from the beginning again.

Process

Pondi helps automating the following steps:

  1. Tag a new release, operate on the checkout
    1. Check that the target tag (v1.2.3 for version 1.2.3) does not exist yet.
    2. Run hooks (go mod download, go generate), abort if any command fails.
    3. Check that the source has not been modified (so all changes were already committed), abort if otherwise.
    4. Run checks on the source code.
  2. Build binaries and the source code archive in a reproducible way, operate on the tagged release
  3. Publish a new release on GitHub and upload all assets