From 05d9c9029465e66b74c5bbd82a988917b98e51e5 Mon Sep 17 00:00:00 2001 From: Ed Page Date: Wed, 6 Sep 2023 15:17:38 -0500 Subject: [PATCH 1/2] docs(guide): Capitalize GitHub correctly --- src/doc/src/guide/continuous-integration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/doc/src/guide/continuous-integration.md b/src/doc/src/guide/continuous-integration.md index e2ec3bc25e2..45b90db3aa4 100644 --- a/src/doc/src/guide/continuous-integration.md +++ b/src/doc/src/guide/continuous-integration.md @@ -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: From 959ae71df55679277cb50db769f058394ab4b8fd Mon Sep 17 00:00:00 2001 From: Ed Page Date: Wed, 6 Sep 2023 15:18:53 -0500 Subject: [PATCH 2/2] docs(guide): Fix heirarchy for CI Things were flat due to the nesting level they were at and this was overlooked when changing the levels in #12595 --- src/doc/src/guide/continuous-integration.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/doc/src/guide/continuous-integration.md b/src/doc/src/guide/continuous-integration.md index 45b90db3aa4..949af0510bd 100644 --- a/src/doc/src/guide/continuous-integration.md +++ b/src/doc/src/guide/continuous-integration.md @@ -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: @@ -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: @@ -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 `` and `` to the repo to clone and