Skip to content

Commit 093a1db

Browse files
authored
Merge pull request #71 from MichaelCurrin/patch-1
docs: fix broken link
2 parents 8d5bf18 + df4a55e commit 093a1db

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

github-actions/simple-ci/README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,33 @@
11
# simple-ci
22

33
The `simple-ci` action allows you to easily build and test your Rust projects.
4-
See [`actions.yml`] for configuration options.
54

6-
[`actions.yml`]: ./actions.yml
5+
See [`action.yml`] for configuration options.
6+
7+
[`action.yml`]: ./action.yml
78

89
## Examples
910

1011
### Simple
12+
1113
This builds, tests, and checks the formatting of your project.
14+
1215
```yaml
1316
- uses: rust-lang/simpleinfra/github-actions/simple-ci@master
1417
with:
1518
check_fmt: true
1619
```
1720
1821
### Complete Template
22+
1923
This template builds and tests your project on stable, beta, and nightly across
2024
linux, macos, windows.
2125
2226
```yaml
2327
name: CI
28+
2429
on: [push, pull_request]
30+
2531
jobs:
2632
build:
2733
runs-on: ${{ matrix.os }}
@@ -39,20 +45,20 @@ jobs:
3945
4046
The action is written in NodeJS 12, and you can install the dependencies with:
4147
42-
```
48+
```sh
4349
npm install
4450
```
4551

4652
### Running
4753

48-
```
54+
```sh
4955
npm start
5056
```
5157

5258
GitHub Actions requires all the dependencies to be committed, so before
5359
creating a commit you need to run:
5460

55-
```
61+
```sh
5662
npm run build
5763
```
5864

0 commit comments

Comments
 (0)