Skip to content

Commit d7421e6

Browse files
[llvm] Proofread CIBestPractices.rst (llvm#161324)
1 parent e457307 commit d7421e6

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

llvm/docs/CIBestPractices.rst

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ This document contains a list of guidelines and best practices to use when
99
working on LLVM's CI systems. These are intended to keep our actions reliable,
1010
consistent, and secure.
1111

12-
Github Actions Best Practices
12+
GitHub Actions Best Practices
1313
=============================
1414

1515
This section contains information on best practices/guidelines when working on
16-
LLVM's github actions workflows.
16+
LLVM's GitHub actions workflows.
1717

1818
Disabling Jobs In Forks
1919
-----------------------
@@ -35,7 +35,7 @@ jobs specified within a workflow:
3535
if: github.repository_owner == 'llvm'
3636
3737
We choose to use ``github.repository_owner`` rather than ``github.repository``
38-
to enable these workflows to run in forks inside the LLVM organization such as
38+
to enable these workflows to run in forks inside the LLVM organization, such as
3939
the ClangIR fork.
4040

4141
There are some exceptions to this rule where ``github.repository`` might be
@@ -46,7 +46,7 @@ release tasks, which should not run anywhere else.
4646
Hash Pinning Dependencies
4747
-------------------------
4848

49-
Github Actions allows the use of actions from other repositories as steps in
49+
GitHub Actions allows the use of actions from other repositories as steps in
5050
jobs. We take advantage of various actions for a variety of different tasks,
5151
but especially tasks like checking out the repository, and
5252
downloading/uploading build caches. These actions are typically versioned with
@@ -59,9 +59,9 @@ just a release, which looks like the following:
5959
uses: actions/checkout@v4
6060
6161
However, it is best practice to specify an exact commit SHA from which to pull
62-
the action from, noting the version in a comment:
62+
the action, noting the version in a comment:
6363

64-
We plan on revisiting this recommendation once Github's immutable actions have
64+
We plan on revisiting this recommendation once GitHub's immutable actions have
6565
been rolled out as GA.
6666

6767
.. code-block:: yaml
@@ -72,22 +72,22 @@ been rolled out as GA.
7272
7373
This is beneficial for two reasons: reliability and security. Specifying an
7474
exact SHA rather than just a major version ensures we end up running the same
75-
action originally specified when the workflow as authored and/or updated,
75+
action originally specified when the workflow was authored and/or updated,
7676
and that no breaking changes sneak in from new versions of a workflow being
7777
released. However, this effect could also be achieved by specifying an exact
7878
dot release. The biggest reason to prefer hash pinned dependencies is security.
79-
Release assets on Github are mutable, allowing an attacker to change the code
79+
Release assets on GitHub are mutable, allowing an attacker to change the code
8080
within a specific version of an action after the fact, potentially stealing
8181
sensitive tokens and credentials. Hash pinning the dependencies prevents this
8282
as the hash would change with the code.
8383

8484
Using Versioned Runner Images
8585
-----------------------------
8686

87-
Github actions allows the use of either specifically versioned runner images
87+
GitHub actions allows the use of either specifically versioned runner images
8888
(e.g., ``ubuntu-22.04``), or just the latest runner image
8989
(e.g., ``ubuntu-latest``). It is best practice to use explicitly versioned
90-
runner images. This prevents breakages when Github rolls the latest runner
90+
runner images. This prevents breakages when GitHub rolls the latest runner
9191
image to a new version with potentially breaking changes, instead allowing us
9292
to explicitly opt-in to using the new image when we have done sufficient
9393
testing to ensure that our existing workflows work as expected in the new
@@ -112,7 +112,7 @@ the principle of least privilege.
112112
Ensuring Workflows Run on the Correct Events
113113
--------------------------------------------
114114

115-
Github allows workflows to run on a multitude of events and it is important to
115+
GitHub allows workflows to run on a multitude of events, and it is important to
116116
configure a workflow such that it triggers on the correct events. There are
117117
two main best practices around events that trigger workflows:
118118

0 commit comments

Comments
 (0)