autocrate

Crates.io	autocrate
lib.rs	autocrate
version	0.1.0-prealpha.3
source	src
created_at	2024-01-23 23:07:01.676459
updated_at	2024-02-24 13:54:23.823997
description	Release Manager for Your Projects on Gitea, GitHub, and GitLab
homepage	https://git.cscherr.de/PlexSheep/autocrate
repository	https://git.cscherr.de/PlexSheep/autocrate
max_upload_size
id	1111304
size	181,562

Christoph J. Scherr (PlexSheep)

documentation

README

Autocrate

Crates.io License Gitea Release Gitea language count

logo

Disclaimer: I've generated the Readme and logo with the help of so called AI tools and modified them afterwards.

Autocrate simplifies the creation and maintenance of releases for your Rust projects hosted on Gitea servers. By providing essential functionalities like uploading artifacts, publishing crates, and managing changelogs, Autocrate streamlines the release process, allowing developers to focus on their work. Although initially built for Gitea, we plan to extend support for additional platforms such as GitHub and GitLab.

Take a look at the scripts directory! publish.sh and release.sh are exactly what I'm trying to get rid of.

Features

Create and update releases on your Gitea server
Publish crates to Cargo.rs or other repositories directly from your Rust projects
Upload artifacts, including documentation and binaries, alongside your releases
Generate and maintain changelogs and release notes.

Upcoming Features

My goal is to continuously enhance Autocrate to better serve the developer community. Some planned improvements include supporting other popular hosting platforms, enabling even greater flexibility and convenience.

Getting Started

Before getting started with Autocrate, make sure you have the necessary prerequisites covered:

A Rust Environment: Install the latest stable Rust compiler and associated tools via the official website: https://www.rust-lang.org/
Access to a Gitea Server (such as git.cscherr.de and codeberg.org (strictly speaking, uses a Gitea fork)

Installing

Once the above pre-requisites are met, begin setting up Autocrate by running the following command in your terminal:

$ cargo install autocrate

This command downloads from crates.io and compiles Autocrate locally, making it readily accessible through your command line interfaces.

Configuring Autocrate

Create a YAML file named .autocrate.yml (or .yaml) in the root of your Git repository. It should contain the following parameters (replace the placeholders):

Parent	Key	Value	Explanation
(root)	`changelog`	list of keys with this as parent (`git-log` etc)	information on how a changelog is generated
`changelog`	`enable`	`true`/`false`	If false, no changelog will be generated
`changelog`	`git-log`	`true`/`false`	should a changelog be generated with `git log`?
(root)	`uses`	list of keys with this as parent (`cargo` etc)	Marks features to be used by Autocrate
`uses`	`cargo`	list of keys with this as parent (`publish` etc)	tells us that your project uses cargo
`cargo`	`publish`	`true`/`false`	should we publish crates?
`cargo`	`registries`	registries see this	A list of registries we should publish to. If empty defaults to `crates.io`.
(root)	`api`	list of names, which each have the same keys	defines the api we talk to
`api.NAME`	`type`	one of `gitea`,`github`,`gitlab` (currently only support for `gitea`	Let's us know which api type we are talking to
`api.NAME`	`endpoint`	Base URL of the target server	Let's us know which api type we are talking to
`api.NAME`	`auth`	list of keys with this as parent (`user` and `pass`)	We probably need authentication on the target server
`api.NAME.auth`	`user`	a string	Which user should we try to authenticate as
`api.NAME.auth`	`pass`	contains either of `text`, `env` or `file`	sets the secret for authentication with this server
`api.NAME.auth.pass`	`text`	a authentication pass as clear text	A secret for authentication of the server, probably a token
`api.NAME.auth.pass`	`env`	env var which contains the token	A secret for authentication of the server, probably a token
`api.NAME.auth.pass`	`file`	file var which contains the token	A secret for authentication of the server, probably a token

An example .autocrate.yaml could look like this:

changelog:
  enable: true
  git-log: true

uses:
  cargo:
    publish: true
  # tokens are loaded from ~/.cargo/config.toml
    registries:
    - default
    - cscherr

api:
  github:
    type: github
    endpoint: https://github.com
    auth:
      user: PlexSheep
      pass:
        text: token_superimportantsecret
  cscherr:
    type: gitea
    endpoint: https://git.cscherr.de
    auth:
      user: PlexSheep
      pass:
        file: secrettoken.txt

After Autocrate has been bootstrapped, it will be released and published with itself, so you can take a look at this repositories .autocrate.yaml.

Using Autocrate

TBD

Licensing

Autocrate is free software.

The Autocrate project is distributed under the terms of the GPL-3 License. Please refer to LICENSE for complete licensing details.

Project status

The project has started recently and is currently in pre-alpha.

Contributing

I'd be very happy to get contributions! Although the master repository is on my self hosted git server, you're free to create issues, PRs and so on on GitHub. If enough activity comes around, moving to GitHub might be a good idea.

If you have any questions, use issues and discussions tabs or write me an email to software@cscherr.de

Commit count: 0