Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(guide): Apply feedback on CI #12630

Merged
merged 2 commits into from
Sep 6, 2023
Merged

docs(guide): Apply feedback on CI #12630

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
05d9c90
docs(guide): Capitalize GitHub correctly
epage Sep 6, 2023
959ae71
docs(guide): Fix heirarchy for CI
epage Sep 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions src/doc/src/guide/continuous-integration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

A basic CI will build and test your projects:

## GitHub Actions
### GitHub Actions

To test your package on GitHub Actions, here is a sample `.github/workflows/ci.yml` file:

Expand Down Expand Up @@ -38,7 +38,7 @@ jobs:

This will test all three release channels (note a failure in any toolchain version will fail the entire job). You can also click `"Actions" > "new workflow"` in the GitHub UI and select Rust to add the [default configuration](https://github.com/actions/starter-workflows/blob/main/ci/rust.yml) to your repo. See [GitHub Actions documentation](https://docs.github.com/en/actions) for more information.

## GitLab CI
### GitLab CI

To test your package on GitLab CI, here is a sample `.gitlab-ci.yml` file:

Expand Down Expand Up @@ -67,7 +67,7 @@ breakage in nightly will not fail your overall build. Please see the
[GitLab CI documentation](https://docs.gitlab.com/ce/ci/yaml/index.html) for more
information.

## builds.sr.ht
### builds.sr.ht

To test your package on sr.ht, here is a sample `.build.yml` file.
Be sure to change `<your repo>` and `<your project>` to the repo to clone and
Expand Down Expand Up @@ -139,7 +139,7 @@ Some potential solutions include:
- Only uses the resources necessary
- Can configure the frequency to balance CI resources and coverage of dependency versions

An example CI job to verify latest dependencies, using Github Actions:
An example CI job to verify latest dependencies, using GitHub Actions:
```yaml
jobs:
latest_deps:
Expand Down