Skip to content
This repository has been archived by the owner on Oct 13, 2023. It is now read-only.

Commit

Permalink
Markup fixes, funding link
Browse files Browse the repository at this point in the history
  • Loading branch information
svartalf committed Sep 16, 2019
1 parent 922b652 commit 40bd4c0
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 10 deletions.
1 change: 1 addition & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
custom: https://svartalf.info/donate/
8 changes: 5 additions & 3 deletions recipes/msrv.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,18 @@
## Quickstart + MSRV CI workflow
# Quickstart + MSRV CI workflow

This workflow is doing almost the same what [Quickstart workflow](../quickstart.md) does,
except all jobs are invoked twice: for latest stable Rust and
for MSRV (Minimal Supported Rust Version) toolchain.

### When it can be used?
## When it can be used?

1. You have a simple Rust project
2. It can be compiled with the `stable` Rust compiler
3. You also have a policy about minimal supported Rust version (ex. "*this crate can be compiled with Rust 1.31.0 and higher*")
and you want to guarantee that

## Workflow

```yaml
on: [push, pull_request]

Expand Down Expand Up @@ -94,7 +96,7 @@ jobs:
args: -- -D warnings
```
### Can I tune it?
## Can I tune it?
Sure!
Expand Down
10 changes: 6 additions & 4 deletions recipes/nightly-lints.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Nightly lints CI workflow
# Nightly lints CI workflow

This workflow installs latest nightly Rust version
and invokes these commands in parallel:
Expand All @@ -8,13 +8,15 @@ and invokes these commands in parallel:
* [`cargo fmt`](https://github.com/rust-lang/rustfmt)
* [`cargo clippy`](https://github.com/rust-lang/rust-clippy)

### When it can be used?
## When it can be used?

1. You are living on an edge
2. You prefer to use `nightly` versions of `clippy` and `rustfmt`,
as they have more options available
3. You hate when today's `nightly` is missing `clippy` and your CI build is broken now

## Workflow

```yaml
on: [push, pull_request]

Expand Down Expand Up @@ -60,7 +62,7 @@ jobs:
args: --all -- --check
```
### Alright, what's going on here?
## Alright, what's going on here?
[`actions-rs/components-nightly`](https://github.com/actions-rs/components-nightly) Action
helps you by searching for a latest `nightly` build with the `component` requested.
Expand All @@ -69,7 +71,7 @@ Found toolchain name is used later by the [`actions-rs/toolchain`](https://githu
so instead of breaking your CI build, you are just falling back to the most recent `nightly` build
where `clippy` is available and can be invoked.

### Can I tune it?
## Can I tune it?

Sure!

Expand Down
6 changes: 3 additions & 3 deletions recipes/quickstart.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Quickstart CI workflow
# Quickstart CI workflow

This workflow installs latest stable Rust version
and invokes these commands in parallel:
Expand All @@ -8,7 +8,7 @@ and invokes these commands in parallel:
* [`cargo fmt`](https://github.com/rust-lang/rustfmt)
* [`cargo clippy`](https://github.com/rust-lang/rust-clippy)

### When it can be used?
## When it can be used?

1. You have a simple Rust project
2. There is no OS-specific code
Expand Down Expand Up @@ -78,7 +78,7 @@ jobs:
args: -- -D warnings
```
### Can I tune it?
## Can I tune it?
Sure!
Expand Down

0 comments on commit 40bd4c0

Please sign in to comment.