Skip to content

Commit d45bfba

Browse files
desrosjdesrosj
committed
Build/Test Tools: Correct some GitHub Action workflow inline documentation.
See #55652. git-svn-id: https://develop.svn.wordpress.org/trunk@53592 602fd350-edb4-49c9-b593-d223f7449a82
1 parent d75d6ca commit d45bfba

7 files changed

Lines changed: 31 additions & 30 deletions

File tree

‎.github/workflows/coding-standards.yml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -115,10 +115,10 @@ jobs:
115115
#
116116
# Performs the following steps:
117117
# - Checks out the repository.
118-
# - Logs debug information about the runner container.
119-
# - Installs NodeJS 14.
118+
# - Logs debug information about the GitHub Action runner.
119+
# - Installs NodeJS.
120120
# - Logs updated debug information.
121-
# _ Installs NPM dependencies using install-changed to hash the `package.json` file.
121+
# _ Installs NPM dependencies.
122122
# - Run the WordPress JSHint checks.
123123
# - Ensures version-controlled files are not modified or deleted.
124124
jshint:

‎.github/workflows/end-to-end-tests.yml‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name: End-to-end Tests
22

33
on:
4-
# The end to end test suite was introduced in WordPress 5.3.
4+
# The end-to-end test suite was introduced in WordPress 5.3.
55
push:
66
branches:
77
- trunk
@@ -31,11 +31,11 @@ jobs:
3131
# Runs the end-to-end test suite.
3232
#
3333
# Performs the following steps:
34-
# - Set environment variables.
34+
# - Sets environment variables.
3535
# - Checks out the repository.
36-
# - Logs debug information about the runner container.
37-
# - Installs NodeJS 14.
38-
# _ Installs NPM dependencies using install-changed to hash the `package.json` file.
36+
# - Logs debug information about the GitHub Action runner.
37+
# - Installs NodeJS.
38+
# _ Installs NPM dependencies.
3939
# - Builds WordPress to run from the `build` directory.
4040
# - Starts the WordPress Docker container.
4141
# - Logs general debug information.

‎.github/workflows/javascript-tests.yml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,10 @@ jobs:
4242
#
4343
# Performs the following steps:
4444
# - Checks out the repository.
45-
# - Logs debug information about the runner container.
46-
# - Installs NodeJS 14.
45+
# - Logs debug information about the GitHub Action runner.
46+
# - Installs NodeJS.
4747
# - Logs updated debug information.
48-
# _ Installs NPM dependencies using install-changed to hash the `package.json` file.
48+
# _ Installs NPM dependencies.
4949
# - Run the WordPress QUnit tests.
5050
# - Ensures version-controlled files are not modified or deleted.
5151
test-js:

‎.github/workflows/phpunit-tests.yml‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -38,18 +38,18 @@ jobs:
3838
# This prevents workflow runs from being marked as "failed" when only PHP 8.1 fails.
3939
#
4040
# Performs the following steps:
41-
# - Set environment variables.
41+
# - Sets environment variables.
4242
# - Sets up the environment variables needed for testing with memcached (if desired).
43-
# - Installs NodeJS 14.
43+
# - Installs NodeJS.
4444
# - Installs NPM dependencies
4545
# - Configures caching for Composer.
46-
# - Installs Composer dependencies (if desired).
47-
# - Logs Docker debug information (about both the Docker installation within the runner).
46+
# - Installs Composer dependencies.
47+
# - Logs Docker debug information (about the Docker installation within the runner).
4848
# - Starts the WordPress Docker container.
49-
# - Starts the memcached server after the Docker network has been created (if desired).
50-
# - Logs WordPress Docker container debug information.
51-
# - Logs debug general information.
49+
# - Starts the Memcached server after the Docker network has been created (if desired).
50+
# - Logs general debug information about the runner.
5251
# - Logs the running Docker containers.
52+
# - Logs debug information from inside the WordPress Docker container.
5353
# - Logs debug information about what's installed within the WordPress Docker containers.
5454
# - Install WordPress within the Docker container.
5555
# - Run the PHPUnit tests.

‎.github/workflows/slack-notifications.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ jobs:
3737
#
3838
# Performs the following steps:
3939
# - Retrieves the current workflow run.
40-
# - Determine the conclusion of the previous workflow run or run attempt.
40+
# - Determines the conclusion of the previous workflow run or run attempt.
4141
# - Sets the previous conclusion as an output.
4242
# - Prepares the commit message.
4343
# - Constructs and stores a message payload as an output.

‎.github/workflows/test-coverage.yml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,12 +35,12 @@ jobs:
3535
# Sets up WordPress for testing or development use.
3636
#
3737
# Performs the following steps:
38-
# - Set environment variables.
38+
# - Sets environment variables.
3939
# - Checks out the repository.
4040
# - Checks out the WordPress Importer plugin (needed for the Core PHPUnit tests).
41-
# - Logs debug information about the runner container.
42-
# - Installs NodeJS 14.
43-
# _ Installs NPM dependencies using install-changed to hash the `package.json` file.
41+
# - Logs debug information about the GitHub Action runner.
42+
# - Installs NodeJS.
43+
# _ Installs NPM dependencies.
4444
# - Logs Docker debug information (about the Docker installation within the runner).
4545
# - Starts the WordPress Docker container.
4646
# - Logs debug general information.

‎.github/workflows/test-npm.yml‎

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,9 @@ jobs:
3838
#
3939
# Performs the following steps:
4040
# - Checks out the repository.
41-
# - Logs debug information about the runner container.
42-
# - Installs NodeJS 14.
43-
# _ Installs NPM dependencies using install-changed to hash the `package.json` file.
41+
# - Logs debug information about the GitHub Action runner.
42+
# - Installs NodeJS.
43+
# _ Installs NPM dependencies.
4444
# - Builds WordPress to run from the `build` directory.
4545
# - Cleans up after building WordPress to the `build` directory.
4646
# - Ensures version-controlled files are not modified or deleted.
@@ -98,13 +98,14 @@ jobs:
9898

9999
# Verifies that installing NPM dependencies and building WordPress works as expected on MacOS.
100100
#
101-
# This is a separate job in order to that more strict conditions can be used.
101+
# This is separate from the job above in order to use stricter conditions about when to run.
102+
# This avoids unintentionally consuming excessive minutes, as MacOS jobs consume minutes at a 10x rate.
102103
#
103104
# Performs the following steps:
104105
# - Checks out the repository.
105-
# - Logs debug information about the runner container.
106-
# - Installs NodeJS 14.
107-
# _ Installs NPM dependencies using install-changed to hash the `package.json` file.
106+
# - Logs debug information about the GitHub Action runner.
107+
# - Installs NodeJS.
108+
# _ Installs NPM dependencies.
108109
# - Builds WordPress to run from the `build` directory.
109110
# - Cleans up after building WordPress to the `build` directory.
110111
# - Ensures version-controlled files are not modified or deleted.

0 commit comments

Comments
 (0)