From b8288087ab32f86e88199c4838a8dbce38941481 Mon Sep 17 00:00:00 2001 From: Melfely Date: Fri, 11 Sep 2026 16:48:00 +0000 Subject: [PATCH] Merge in the Release-Plz Setup (#6) This Pull Request will setup the process of Automatic release of everything in the workspace. Adds in a README.md file. --------- Co-authored-by: ci-bot Reviewed-on: https://gitea.melfely.com/melfely/rust_workflow_template/pulls/6 Co-authored-by: Melfely --- .cargo/config.toml | 2 +- .gitea/workflows/release-plz.yml | 82 ++++++++++++++++++++++++++++++++ Cargo.lock | 7 ++- README.md | 58 +++++++++++++++++++++- example_bin/CHANGELOG.md | 14 ++++++ example_bin/Cargo.toml | 3 +- example_bin/src/main.rs | 8 ++++ example_lib/CHANGELOG.md | 14 ++++++ example_lib/Cargo.toml | 2 +- example_lib/src/lib.rs | 6 +++ 10 files changed, 189 insertions(+), 7 deletions(-) create mode 100644 .gitea/workflows/release-plz.yml create mode 100644 example_bin/CHANGELOG.md create mode 100644 example_lib/CHANGELOG.md diff --git a/.cargo/config.toml b/.cargo/config.toml index 4bf0f90..f459046 100644 --- a/.cargo/config.toml +++ b/.cargo/config.toml @@ -1,2 +1,2 @@ [registries.gitea] -index = "sparse+https://gitea.example.com/api/packages/crates/cargo/" +index = "sparse+https://gitea.melfely.com/api/packages/crates/cargo/" diff --git a/.gitea/workflows/release-plz.yml b/.gitea/workflows/release-plz.yml new file mode 100644 index 0000000..6410660 --- /dev/null +++ b/.gitea/workflows/release-plz.yml @@ -0,0 +1,82 @@ +name: Release-plz + +on: + push: + branches: + - [main, master] + +jobs: + + # Release unpublished packages. + release-plz-release: + name: Release-plz release + runs-on: ubuntu-latest + + permissions: + contents: write + pull-requests: read + + steps: + + - &setup-git-user + name: Config Git User + run: | + git config --global user.name "ci-bot" + git config --global user.email "bot@email.melfely.com" + + - &checkout + name: Checkout repository + uses: actions/checkout@v6 + with: + fetch-depth: 0 + persist-credentials: false + + - &install-rust + name: Install Rust toolchain + uses: dtolnay/rust-toolchain@stable + + - &install-cargo-semver + name: Install Cargo SemVer Checks + uses: taiki-e/install-action@fa23953489c080190314742a9b907f8e97c6767c # v2.87.10 + with: + tool: cargo-semver-checks + + - &install-release-plz + name: Install release-plz + uses: taiki-e/install-action@fa23953489c080190314742a9b907f8e97c6767c # v2.87.10 + with: + tool: release-plz + + + + - name: Run release-plz release + run: | + release-plz release --forge gitea --git-token ${{ secrets.GITEA_TOKEN }} --registry gitea --token "Bearer ${{ secrets.CARGO_REGISTRIES_GITEA_TOKEN }}" + # Create a PR with the new versions and changelog, preparing the next releases + release-plz-pr: + name: Release-plz PR + runs-on: ubuntu-latest + + permissions: + contents: write + pull-requests: write + + concurrency: + group: release-plz-${{ github.ref }} + cancel-in-progress: false + + steps: + - *setup-git-user + - *checkout + - *install-rust + - *install-cargo-semver + - *install-release-plz + + - name: Fill Credentials + run: | + git config --global credential.helper store + echo "https://ci-bot:${{ secrets.GITEA_TOKEN }}@gitea.melfely.com" > ~/.git-credentials + + - name: Run release-plz release-pr + run: | + release-plz release-pr --forge gitea --git-token ${{ secrets.GITEA_TOKEN }} --registry gitea diff --git a/Cargo.lock b/Cargo.lock index 3bc11c1..c06043a 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -4,8 +4,11 @@ version = 4 [[package]] name = "example_bin" -version = "0.1.0" +version = "0.1.1" +dependencies = [ + "example_lib", +] [[package]] name = "example_lib" -version = "0.1.0" +version = "0.1.1" diff --git a/README.md b/README.md index b817760..ddb202f 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,57 @@ -# rust_workflow_template +# Rust Workspace Template with Pre-Configured Workflows + +This Setup does ALOT of checking and analyis before letting you push to main/master. Requiring a massive amount of Cross-Platform support. + +## Why? + +This automates everything from linting, to CI/CD. This allows us to just work on projects, as long as we follow the rules, without having to worry about deployement. + +Fully automating out an entire departement in most companies called DevOps. + +**You just need to pay attention to the following** + +## How to use properly. + +This is an EXAMPLE workspace, look around at the how the Cargo.Toml files are setup, they are important. Once you get comfortable, delete the existing stuff, and start making your own. + +A few major points. + +### Git Commits + +This uses a tool to auto generate change logs and version indexing. As LONG as you feed it good data, one of such requirements are good commits + +This project **REQUIRES** you to use the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) format. This allows for a whole HOST of good automated tooling. That you will love, in comparison to doing it all by hand. WHILE adding a bit of a requirement to making good split up commits. + +Any commits **not** following this standard should be rejected or reworded. If a commit is *to large* or some other problem to not fit the mold. Then change the commit, do **NOT** break the rules. + +### Gitea Registry + +We don't publish to crates.io, instead we publish to the pre-configured gitea crates repo. Which keeps everything private. Does have the disadvantage of reqiuring a bit of extra work to use. + +In the example_bin Cargo.toml file you can see + +```toml +example_lib = { version = "0.1.1", path = "../example_lib", registry = "gitea" } +``` + +This line is VERY important, it uses a PATH based dependency to find the project. Which allows for it to be live. + +Note that the version number will need to be updated, along WITH the fact that you need to make sure that it uses the "gitea" regsitry here as well. That is where cargo will expect to find it at later. + +### Workspace + +in the root level Cargo.toml is the workspace config +```toml +[workspace] +resolver = "3" +members = ["example_bin", "example_lib"] +``` + +notice how it LISTS all the crates that are members of the workspace? That is important! + +### Cargo Lock files + +All of the workflow tools remotely use --locked versions of cargo build and check, so therefore it **CANNOT** update the lock files. + +The lock files are what versions of a package you are using when it was built. This is all about the philophsy of [reproducible builds](https://reproducible-builds.org/) -Rust Cargo Template with CI/CD Setup. \ No newline at end of file diff --git a/example_bin/CHANGELOG.md b/example_bin/CHANGELOG.md new file mode 100644 index 0000000..f8f4407 --- /dev/null +++ b/example_bin/CHANGELOG.md @@ -0,0 +1,14 @@ +# 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). + +## [Unreleased] + +## [0.1.1](https://gitea.melfely.com/melfely/rust_workflow_template/compare/example_bin-v0.1.0...example_bin-v0.1.1) - 2026-09-11 + +### Added + +- bin example now references the local example_lib diff --git a/example_bin/Cargo.toml b/example_bin/Cargo.toml index d734bc5..f43e26e 100644 --- a/example_bin/Cargo.toml +++ b/example_bin/Cargo.toml @@ -1,6 +1,7 @@ [package] name = "example_bin" -version = "0.1.0" +version = "0.1.1" edition = "2024" [dependencies] +example_lib = { path = "../example_lib" } diff --git a/example_bin/src/main.rs b/example_bin/src/main.rs index e7a11a9..ee45461 100644 --- a/example_bin/src/main.rs +++ b/example_bin/src/main.rs @@ -1,3 +1,11 @@ +use example_lib::*; + fn main() { println!("Hello, world!"); + + let result = add(1, 1); + assert_eq!(result, 2); + + let result = sub(1, 1); + assert_eq!(result, 0); } diff --git a/example_lib/CHANGELOG.md b/example_lib/CHANGELOG.md new file mode 100644 index 0000000..eb64fb6 --- /dev/null +++ b/example_lib/CHANGELOG.md @@ -0,0 +1,14 @@ +# 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). + +## [Unreleased] + +## [0.1.1](https://gitea.melfely.com/melfely/rust_workflow_template/compare/example_lib-v0.1.0...example_lib-v0.1.1) - 2026-09-11 + +### Added + +- added pub fn sub() diff --git a/example_lib/Cargo.toml b/example_lib/Cargo.toml index 2794f7e..b3d27cf 100644 --- a/example_lib/Cargo.toml +++ b/example_lib/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "example_lib" -version = "0.1.0" +version = "0.1.1" edition = "2024" [dependencies] diff --git a/example_lib/src/lib.rs b/example_lib/src/lib.rs index b93cf3f..9628316 100644 --- a/example_lib/src/lib.rs +++ b/example_lib/src/lib.rs @@ -2,6 +2,10 @@ pub fn add(left: u64, right: u64) -> u64 { left + right } +pub fn sub(left: u64, right: u64) -> u64 { + left - right +} + #[cfg(test)] mod tests { use super::*; @@ -10,5 +14,7 @@ mod tests { fn it_works() { let result = add(2, 2); assert_eq!(result, 4); + let result = sub(2, 2); + assert_eq!(result, 0); } }