Prepare for initial crate release

.github/dependabot.yml

@@ -0,0 +1,18 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+  - package-ecosystem: "cargo" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"
+    groups:
+      cargo-dependencies:
+        patterns: ["*"]

.github/workflows/check.yml

@@ -0,0 +1,15 @@
+name: Check
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  check:
+    permissions:
+      checks: write
+    uses: joshka/github-workflows/.github/workflows/rust-check.yml@main
+    with:
+      msrv: 1.76.0 # this is optional defaults to 1.56.0

.github/workflows/release-plz.yml

@@ -0,0 +1,20 @@
+name: Release
+
+permissions:
+  pull-requests: write
+  contents: write
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+
+jobs:
+  release-plz:
+    uses: joshka/github-workflows/.github/workflows/rust-release-plz.yml@main
+    permissions:
+      pull-requests: write
+      contents: write
+    secrets:
+      CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}

.github/workflows/test.yml

@@ -0,0 +1,13 @@
+name: Test
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  test:
+    uses: joshka/github-workflows/.github/workflows/rust-test.yml@main
+    secrets:
+      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

CHANGELOG.md

@@ -0,0 +1,20 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [unreleased]
+
+- [3e7b6818](https://github.com/joshka/ratatui_bevy/commit/3e7b68186b896b8ddf5ab1a533e511ef8010a791): Initial implementation
+- [f224c58a](https://github.com/joshka/ratatui_bevy/commit/f224c58a6d90807c51153a86ed03e60919d68f8f): Rearrange to modules
+- [2e5a68fa](https://github.com/joshka/ratatui_bevy/commit/2e5a68fa45a09c46c1974f15d4c3ba0caaa7be2e): Add plugin per module
+- [31bd387b](https://github.com/joshka/ratatui_bevy/commit/31bd387b75b224a0621a5d402acd5b5ff2fd5e29): Formatting
+- [97004166](https://github.com/joshka/ratatui_bevy/commit/970041663ab9b09669fd57a3bc8c8276d1b48c04): Demonstrate how bevy makes changing state elsewhere in the app easy
+
+  Some context: https://forum.ratatui.rs/t/how-do-i-represent-application-state-ergonomically/54/13
+- [e35958a5](https://github.com/joshka/ratatui_bevy/commit/e35958a5ce47624b9e14255e62ba4c55ea2aaf44): Add readme
+- [0c789e27](https://github.com/joshka/ratatui_bevy/commit/0c789e27084440329a23513bc3e778f8901faa94): Disable bevy default features for speeding up compile times
+- [97bf55f6](https://github.com/joshka/ratatui_bevy/commit/97bf55f6000fa13efaea23da8826469ddca2a8c6): Create LICENSE
+- [84d7155c](https://github.com/joshka/ratatui_bevy/commit/84d7155c7498fdd6ef785edc8487fc45b603ea8b): Add keys / instructions to readme
+- [85d60840](https://github.com/joshka/ratatui_bevy/commit/85d608402ce58654e1f48fcbd8cb09def3358334): Animate the background color when changing from positive to negative
+- [f3bc4c7c](https://github.com/joshka/ratatui_bevy/commit/f3bc4c7c4d9a21a83207b57545920ac3be78f24f): Add demo and tweak colors / timing
+- [83603edf](https://github.com/joshka/ratatui_bevy/commit/83603edf13c5fe3e648835c9745d2bfd527b593f): Add readme info<!-- generated by git-cliff -->

Cargo.toml

@@ -1,7 +1,13 @@
 [package]
 name = "bevy_ratatui"
-version = "0.1.0"
+version = "0.3.0"
 edition = "2021"
+license = "MIT OR Apache-2.0"
+repository = "https://github.com/joshka/bevy_ratatui"
+documentation = "https://docs.rs/bevy_ratatui"
+authors = ["Joshka"]
+categories = ["command-line-interface"]
+keywords = ["cli", "ratatui", "terminal", "tui", "bevy"]
 
 [dependencies]
 bevy = { version = "0.13.2", default-features = false, features = [

README.md

@@ -49,6 +49,13 @@ Keys:
     egui backend to render ratatui apps to the web
   - <https://github.com/sstelfox/bevy_tui> - tui-rs / bevy seems dead (last commit Jan 2023)
 
+## Previous bevy_ratatui crate
+
+Previously there was another crate using this name which has since migrated to
+[ratatui_egui_wasm](https://github.com/gold-silver-copper/ratatui_egui_wasm).  A ratatui backend
+that is also an egui widget. Deploy on web with WASM or ship natively with bevy, macroquad, or
+eframe. Demo at <https://gold-silver-copper.github.io/>
+
 ## License
 
 Copyright (c) Josh McKinney

cliff.toml

@@ -0,0 +1,67 @@
+# git-cliff ~ default configuration file
+# https://git-cliff.org/docs/configuration
+#
+# Lines starting with "#" are comments.
+# Configuration options are organized into tables and keys.
+# See documentation for more information on available options.
+
+[changelog]
+# changelog header
+header = """
+# Changelog\n
+All notable changes to this project will be documented in this file.\n
+"""
+# template for the changelog body
+# https://keats.github.io/tera/docs/#introduction
+body = """
+{% if version %}\
+    ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
+{% else %}\
+    ## [unreleased]
+{% endif %}\
+{% for commit in commits %}
+- [{{ commit.id | truncate(length=8,end="") }}](<REPO>/commit/{{ commit.id }}): {{ commit.message | upper_first | trim | indent(prefix="  ") }}
+{%- endfor %}
+"""
+# template for the changelog footer
+footer = """
+<!-- generated by git-cliff -->
+"""
+# remove the leading and trailing s
+trim = true
+# postprocessors
+postprocessors = [
+  { pattern = '<REPO>', replace = "https://github.com/joshka/ratatui_bevy" }, # replace repository URL
+]
+
+[git]
+# parse the commits based on https://www.conventionalcommits.org
+conventional_commits = false
+# filter out the commits that are not conventional
+filter_unconventional = false
+# process each line of a commit as an individual commit
+split_commits = false
+# regex for preprocessing the commit messages
+commit_preprocessors = [
+  # Replace issue numbers
+  #{ pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](<REPO>/issues/${2}))"},
+  # Check spelling of the commit with https://github.com/crate-ci/typos
+  # If the spelling is incorrect, it will be automatically fixed.
+  #{ pattern = '.*', replace_command = 'typos --write-changes -' },
+]
+# protect breaking changes from being skipped due to matching a skipping commit_parser
+protect_breaking_commits = false
+# filter out the commits that are not matched by commit parsers
+filter_commits = false
+# regex for matching git tags
+# tag_pattern = "v[0-9].*"
+# regex for skipping tags
+# skip_tags = ""
+# regex for ignoring tags
+# ignore_tags = ""
+# sort the tags topologically
+topo_order = false
+# sort the commits inside sections by oldest/newest order
+sort_commits = "oldest"
+# limit the number of commits included in the changelog.
+# limit_commits = 42