Skip to content

Commit

Permalink
improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ameknite committed Mar 16, 2024
1 parent 77c09ec commit a6e9f01
Showing 1 changed file with 18 additions and 17 deletions.
35 changes: 18 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,16 +32,16 @@ It will run:
- [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/>
- [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](./.github/workflows/build_and_release.yaml)
[build_and_release.yaml](./.github/workflows/build_and_release.yaml)

This workflow will only run manually through GitHub.

Expand All @@ -58,7 +58,7 @@ It will:
- 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
- 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):
Expand All @@ -73,18 +73,19 @@ It will:
- 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
- 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) 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)
- It builds for linux: gnu (x86_64|aarch64) 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 setup
- 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

Expand All @@ -102,14 +103,14 @@ Here you can do three things to run the workflow:
- 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
- Run if you already update your crate version.
- Useful for testing when you already run the workflow.

## Dependabot

This template includes a setup for dependabot and a workflow for auto-merge.

- It will update packages for cargo and github-actions weekly
- It will update packages for cargo and github-actions weekly.

- For rust:
- It will create pull request in groups.
Expand Down Expand Up @@ -139,11 +140,11 @@ Some workflows to consider:
- 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 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
- To publish your crate to crates.io.

## What to change if you want to use this template

Expand All @@ -153,7 +154,7 @@ Some workflows to consider:
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)
- Remove the notice in [main.rs](./deny.toml).
- Or you can run add-notice --remove before you update the NOTICE file.

## LICENSE
Expand All @@ -162,6 +163,6 @@ 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
- [CC0-1.0](LICENSE-CC0-1.0) license.
- [MIT](LICENSE-MIT) license.
- [Apache-2.0](LICENSE-Apache-2.0) license.

0 comments on commit a6e9f01

Please sign in to comment.