base on Template to maintain a rust project running CI/CD with Github Workflows. # Rust CI/CD template [](https://github.com/ameknite/rust-ci-cd-template?tab=readme-ov-file#license) [](https://crates.io/crates/rust-ci-cd-template) [](./Cargo.toml#L8) [](https://github.com/ameknite/rust-ci-cd-template/actions?workflow=CI) Template to maintain a rust project running CI/CD with Github Workflows. <!-- todo!(Change this file) --> ## CI Workflow [ci.yaml](./.github/workflows/ci.yaml)  This workflow will run every time you push to main or make a pull request. You can also run the workflow manually in github. It will run: - cargo build: Compiling for ubuntu-latest. - cargo [fmt](https://github.com/rust-lang/rustfmt): - Rust Formatter. - Check for the file [rustfmt.toml](./rustfmt.toml). - cargo [clippy](https://github.com/rust-lang/rust-clippy): - Lints catch common mistakes and improve your Rust code. - Check for the sections `[lints.rust]` and `[linsts.clippy]` in the [Cargo.toml file](./Cargo.toml). - cargo doc: Build the documentation. - cargo doc --test: Run tests in the documentation, only if the crate is a lib. - [cargo-nextest](https://nexte.st/): Execute unit and integration tests. - [cargo miri](https://github.com/rust-lang/miri) test: Help to detect certain classes of [undefined behavior](https://doc.rust-lang.org/reference/behavior-considered-undefined.html). - [typos](https://crates.io/crates/typos): - Source code spell checker. - Check for the [typos.toml](./typos.toml) file. - [docs](https://github.com/crate-ci/typos/blob/master/docs/reference.md) - [taplo fmt](https://taplo.tamasfe.dev/): Toml formatter. - [markdownlint-cli2](https://github.com/DavidAnson/markdownlint-cli2): - Markdown linter and formatter. - Check for the file [.markdownlint.yaml](./.markdownlint.yaml) - [yamlfmt](https://github.com/google/yamlfmt/): Yaml formatter. - [cargo deny](https://github.com/EmbarkStudios/cargo-deny): - Check for licenses, bans, advisories and sources. - Check for the [deny.toml](./deny.toml) file. - [template](https://github.com/EmbarkStudios/cargo-deny/blob/main/deny.template.toml) - [docs](https://embarkstudios.github.io/cargo-deny/) - [cargo audit](https://crates.io/crates/cargo-audit): - Check for security vulnerabilities. - Uses the [advisory-db](https://github.com/RustSec/advisory-db/) - [cargo msrv](https://github.com/foresterre/cargo-msrv): Keep the rustc version on check. ## CD Workflow   [build_and_release.yaml](./.github/workflows/build_and_release.yaml) This workflow will only run manually through GitHub. It will: - Validate your input version with regex (e.g. v3.1.4-alpha+159). - Run the ci workflow. - Run [cargo semver-checks](https://crates.io/crates/cargo-semver-checks): - Lint your crate API changes for semver violations. - This will only run if you crate is a library. - Uses your previous tag as a baseline. - Run [add-notice](https://crates.io/crates/add-notice): - Add header notices to your rust files. - Check for the [NOTICEe file](./NOTICE). - Auto-commit. - Run [cargo-bump](https://crates.io/crates/cargo-bump): - Bump the current version of the Cargo.toml file. - Uses the input version if provided. - Auto-commit. - Run [cargo-attributions](https://crates.io/crates/cargo-attribution): - Comply with licenses distribution. - Add licenses, notices and metadata of your dependencies. - Crate an [attribution folder](./attribution/) - Auto-commit. - Create a new tag: - Uses the input version if provided. - It's created only if the tag not exists. - Create a new github release: - Uses [create-gh-release-action](https://github.com/taiki-e/create-gh-release-action/tree/v1/) - Includes your changelog if matches the same version. - Uses the created tag as a reference. - Build and Release in Github: - Using [upload-rust-binary-action](https://www.github.com/taiki-e/upload-rust-binary-action/tree/v1/) - And [setup-cross-toolchain-action](https://github.com/taiki-e/setup-cross-toolchain-action/tree/v1/) - Only builds if your crate contains a binary crate. - Uses the created tag as a reference. - Bundle the attribution folder with licenses and notices. - Create checksum with sha256. - It builds for linux: gnu (x86_64|aarch64|riscv64gc) and musl (x86_64|aarch64). - It builds for windows: msvc (x86_64|aarch64) and gnu (x86_64). - It builds for mac-os (x86_64|aarch64). - Publish the create to crates.io: - Only if you have the secrets.CARGO_REGISTRY_TOKEN variable added to repository secrets. - Path: Settings -> Security -> Secrets and variables -> Actions -> Repository secrets. ### How to use the Build and Release workflow You will run this directly in your Github repo -> Section `Actions` -> `[Main] Build & Release` workflow. -> `Run workflow` button.  Here you can do three things to run the workflow: 1. Write the new version you want to release: - The version is in the form of: - Version parts: `${MAJOR}.${MINOR}.${PATCH}-${PRE-RELEASE}+${BUILD}` - Example: 3.1.4-alpha+159 2. Select the release_type you want:  - `patch`, `minor` and `major`. - It will use your current crate version as a baseline. - Keep in `none` if you only want the writing version. 3. Keep all with the defaults (without version and release_type = none) - It will use your current crate version as a baseline. - Run if you already update your crate version. - Useful for testing when you already run the workflow. The two booleans allow you to publish your crate to creates.io and overwrite your tag to add modifications to a release, respectively. ## Dependabot This template includes a setup for dependabot and a workflow for auto-merge. - It will update packages for cargo and github-actions weekly. - For rust: - It will create pull request in groups. - One group for patch updates, one for minor updates and one for major updates. - It will auto-merge the pull request if passes ci. - For github-actions: - It will create a pull request in groups. - Only one group for the updates. - It will auto-merge the pull request if passes ci. ## Other workflows This template uses [workflow call](https://docs.github.com/en/actions/using-workflows/reusing-workflows) and [workflow dispatch](https://docs.github.com/en/actions/using-workflows/manually-running-a-workflow) to reuse workflows and be able to run them individually. So you can run various jobs of the ci/cd workflows independently. Some workflows to consider: - [weekly-workflow](./.github/workflows/weekly.yaml) - Run the ci workflow. - Update Dependencies, Attributions and Notices. - [monthly-workflow](./.github/workflows/monthly.yaml) - Run the build_and_release workflow. - Do a patch release and publish to crates.io - [update_msrv.yaml](./.github/workflows/update_msrv.yaml) - It will run cargo-msrv to update your `rust-version` in Cargo.toml - If you uses the MSRV in your README.md it will also updated it. - [cargo_semver_checks](./.github/workflows/cargo_semver_checks.yaml) - Test semver violations before releasing. - [cache.yaml](./.github/workflows/cache.yaml) - To clean the caches generated for the workflows. - Run if you have problems with the cache. - [add_notice.yaml](./.github/workflows/add_notice.yaml) - To replace and update your notices. - To apply notices to other kind of files. - To use different comment styles. - [publish.yaml](./.github/workflows/publish.yaml) - To publish your crate to crates.io. ## What to change if you want to use this template - Change [this file](.). - Change the metadata in [Cargo.toml](./Cargo.toml) - Change the licenses files. Right now uses [LICENSE-CC0-1.0](./LICENSE-CC0-1.0), [LICENSE-MIT](./LICENSE-MIT) and [LICENSE-Apache-2.0](./LICENSE-Apache-2.0). - Change the [deny.toml](./deny.toml) file. - Change the [NOTICE](./NOTICE) file: - Remove the notice in [main.rs](./deny.toml). - Or you can run add-notice --remove before you update the NOTICE file. - Change the [FUNDING.yaml](./.github/FUNDING.yaml) file. ## Similar projects that might help you - [cargo-dist](https://github.com/axodotdev/cargo-dist?tab=readme-ov-file). - [cargo-release](https://github.com/crate-ci/cargo-release). - [release-plz](https://github.com/MarcoIeni/release-plz). - [cargo-smart-release](https://github.com/Byron/cargo-smart-release). ## LICENSE SPDX-License-Identifier: CC0-1.0 OR MIT OR Apache-2.0 Licensed under a triple license at your option: - [CC0-1.0](LICENSE-CC0-1.0) license. - [MIT](LICENSE-MIT) license. - [Apache-2.0](LICENSE-Apache-2.0) license. ", Assign "at most 3 tags" to the expected json: {"id":"8657","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"