A release automation tool for gitea repos.
Go to file
Cadey Ratio 03004b31e7
continuous-integration/drone/push Build is passing Details
continuous-integration/drone/pr Build is passing Details
rename release to cut
2020-07-08 19:02:31 -04:00
elfs documentation, tests, elfs crate 2020-07-08 18:24:59 -04:00
gitea documentation, tests, elfs crate 2020-07-08 18:24:59 -04:00
nix nix/docker builds 2020-05-31 15:35:00 -04:00
src rename release to cut 2020-07-08 19:02:31 -04:00
testdata VERSION file parsing 2020-05-31 13:05:32 -04:00
.drone.yml domo gitea token 2020-07-08 18:26:23 -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 rename release to cut 2020-07-08 19:02:31 -04:00
CODE_OF_CONDUCT.md add Creator's Code 2020-06-12 07:42:17 -04:00
Cargo.lock documentation, tests, elfs crate 2020-07-08 18:24:59 -04:00
Cargo.toml documentation, tests, elfs crate 2020-07-08 18:24:59 -04:00
LICENSE initial commit 2020-05-30 10:57:18 -04:00
README.md remove all functionality but release creation 2020-07-08 17:36:53 -04:00
TODO.org cmd/release: exit if the tag already exists 2020-06-05 10:50:34 -04:00
VERSION rename release to cut 2020-07-08 19:02:31 -04:00
default.nix nix/docker builds 2020-05-31 15:35:00 -04:00
docker.nix remove all functionality but release creation 2020-07-08 17:36:53 -04:00
shell.nix Allow users to customize the default branch name (#5) 2020-06-12 11:18:13 +00: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 under the steps key:

- name: auto-release
  image: xena/gitea-release:latest
  pull: always
  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.

The default branch will automatically be derived from the Gitea API. If you need to hard-code your default branch name for some reason, add the default_branch setting like this:

  - name: auto-release
    image: xena/gitea-release:latest
    pull: always
    settings:
      auth_username: cadey
      default_branch: trunk
      gitea_server: https://tulpa.dev
      gitea_token:
        from_secret: GITEA_TOKEN
    when:
      event:
        - push
      branch:
        - trunk

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