https://github.com/ickk/bevy-release-generator-next

https://github.com/ickk/bevy-release-generator-next

Last synced: 5 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/ickk/bevy-release-generator-next
• Owner: ickk
• License: mit
• Created: 2023-07-22T05:39:35.000Z (over 1 year ago)
• Default Branch: dev
• Last Pushed: 2023-07-24T00:05:29.000Z (over 1 year ago)
• Last Synced: 2024-04-21T08:12:17.646Z (7 months ago)
• Language: Rust
• Size: 17.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Release Generator

A semi-automatic migration note generator tool for the bevy project.

Original code adapted from `bevy-website/generate-release`

## Setup

You can set up a Github Personal-Access-Token in your user settings

https://github.com/settings/tokens

You can either specify your PAT & github username as environment variables, or

by creating a `.env` file

```sh

GITHUB_USERNAME = "username"

GITHUB_TOKEN = "PAT"

```

Then complete the `relgen.toml` file with the following information

```toml

source_repo = "https://github.com/bevyengine/bevy"

migration_notes_repo = "https://github.com/ickk/migration_notes"

migration_notes_local_path = "./migration_notes"

```

## Usage

```

cargo run -- migration_notes --release 0.11 --from v0.11.0 --to main

```

Git tags, SHAs or other references can be specified in the `--from` & `--to`

arguments. The value of `--release` specifies the subfolder where the notes

will be created.