https://github.com/restic/pondi

Release helper tool for restic and related projects
https://github.com/restic/pondi

Last synced: 3 months ago
JSON representation

Release helper tool for restic and related projects

• Host: GitHub
• URL: https://github.com/restic/pondi
• Owner: restic
• License: bsd-2-clause
• Created: 2020-05-24T12:07:52.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2020-07-19T15:22:44.000Z (about 6 years ago)
• Last Synced: 2025-01-17T16:15:02.581Z (over 1 year ago)
• Language: Go
• Size: 20.5 KB
• Stars: 1
• Watchers: 5
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
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](https://restic.net) backup program have.

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

 * Generate a changelog file using [`calens`](https://github.com/restic/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.

    1. Run hooks (`go mod download`, `go generate`), abort if any command fails.

    1. Check that the source has not been modified (so all changes were already committed), abort if otherwise.

    1. 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