A release automation tool for gitea repos.
Go to file
Cadey Ratio 7d09c0dee0
continuous-integration/drone/push Build is passing Details
continuous-integration/drone/tag Build is passing Details
version 0.2.6
2020-06-01 00:14:32 -04:00
nix nix/docker builds 2020-05-31 15:35:00 -04:00
src use FnMut, drop a bunch of refcells 2020-06-01 12:17:13 +10:00
testdata VERSION file parsing 2020-05-31 13:05:32 -04:00
.drone.yml docker load -i 2020-05-31 16:57:39 -04:00
.envrc initial commit 2020-05-30 10:57:18 -04:00
.gitignore nix/docker builds 2020-05-31 15:35:00 -04:00
CHANGELOG.md version 0.2.6 2020-06-01 00:14:32 -04:00
Cargo.lock docker load -i 2020-05-31 16:57:39 -04:00
Cargo.toml version 0.2.6 2020-06-01 00:14:32 -04:00
LICENSE initial commit 2020-05-30 10:57:18 -04:00
README.md version 0.2.6 2020-06-01 00:14:32 -04:00
TODO.org drone plugin 2020-05-31 15:35:23 -04:00
VERSION version 0.2.6 2020-06-01 00:14:32 -04:00
default.nix nix/docker builds 2020-05-31 15:35:00 -04:00
docker.nix lol oops cacert 2020-05-31 16:00:26 -04:00
shell.nix nix/docker builds 2020-05-31 15:35:00 -04:00

README.md

gitea-release

built with nix Build Status

A small command line tool to automate releases for Gitea repositories that reads from CHANGELOG and VERSION files. This is a clone of github-release, but more suited for my individual needs. This may also turn into a generic webhook handler, but one thing at a time. :)

Installation

With Nix

$ nix-env -if https://tulpa.dev/cadey/gitea-release/archive/master.tar.gz

With cargo

$ cargo install --git https://tulpa.dev/cadey/gitea-release.git

Drone Plugin

To use this as a drone plugin, add the following to your .drone.yml:

- name: auto-release
  image: xena/gitea-release:0.2.6
  settings:
    auth_username: cadey
    changelog_path: ./CHANGELOG.md
    gitea_server: https://tulpa.dev
    gitea_token:
      from_secret: GITEA_TOKEN
  when:
    event:
      - push
    branch:
      - master

Replace the values of the settings as makes sense for your gitea server. The changelog_path attribute is optional, and will be ./CHANGELOG.md by default.

CHANGELOG.md and VERSION files

The CHANGELOG.md file is based on the Keep a Changelog format, but modified slightly to make it easier for this tool. Here is an example changelog that this tool accepts:

# Changelog
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## 0.1.0

Hi there this is a test!

### ADDED

- something

The VERSION file plays into this as well. The VERSION file MUST be a single line containing a semantic version string. When this tool is run with the release subcommand, the following actions take place:

  • The VERSION file is read and loaded as the desired tag for the repo
  • The CHANGELOG.md file is read and the changes for the VERSION are cherry-picked out of the file
  • The git repo is checked to see if that tag already exists
    • If the tag exists, the tool exits and does nothing
  • If the tag does not exist, it is created (with the changelog fragment as the body of the tag) and pushed to the gitea server
  • A gitea release is created using the changelog fragment and the release name is generated from the VERSION string