You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/actions/use-cases-and-examples/building-and-testing/building-and-testing-java-with-ant.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -90,9 +90,9 @@ We recommend that you have a basic understanding of Java and the Ant framework.
90
90
91
91
You can use the same commands that you use locally to build and test your code.
92
92
93
-
The workflow template will run the default target specified in your _build.xml_ file. Your default target will commonly be set to build classes, run tests and package classes into their distributable format, for example, a JAR file.
93
+
The workflow template will run the default target specified in your `build.xml` file. Your default target will commonly be set to build classes, run tests and package classes into their distributable format, for example, a JAR file.
94
94
95
-
If you use different commands to build your project, or you want to run a different target, you can specify those. For example, you may want to run the `jar` target that's configured in your `_build-ci.xml_` file.
95
+
If you use different commands to build your project, or you want to run a different target, you can specify those. For example, you may want to run the `jar` target that's configured in your `build-ci.xml` file.
Copy file name to clipboardExpand all lines: content/actions/use-cases-and-examples/building-and-testing/building-and-testing-java-with-gradle.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -103,7 +103,7 @@ You can use the same commands that you use locally to build and test your code.
103
103
104
104
The workflow template will run the `build` task by default. In the default Gradle configuration, this command will download dependencies, build classes, run tests, and package classes into their distributable format, for example, a JAR file.
105
105
106
-
If you use different commands to build your project, or you want to use a different task, you can specify those. For example, you may want to run the `package` task that's configured in your _ci.gradle_ file.
106
+
If you use different commands to build your project, or you want to use a different task, you can specify those. For example, you may want to run the `package` task that's configured in your `ci.gradle` file.
Copy file name to clipboardExpand all lines: content/actions/use-cases-and-examples/building-and-testing/building-and-testing-java-with-maven.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -97,7 +97,7 @@ You can use the same commands that you use locally to build and test your code.
97
97
98
98
The workflow template will run the `package` target by default. In the default Maven configuration, this command will download dependencies, build classes, run tests, and package classes into their distributable format, for example, a JAR file.
99
99
100
-
If you use different commands to build your project, or you want to use a different target, you can specify those. For example, you may want to run the `verify` target that's configured in a _pom-ci.xml_ file.
100
+
If you use different commands to build your project, or you want to use a different target, you can specify those. For example, you may want to run the `verify` target that's configured in a `pom-ci.xml` file.
101
101
102
102
```yaml copy
103
103
steps:
@@ -127,7 +127,7 @@ steps:
127
127
run: mvn --batch-mode --update-snapshots verify
128
128
```
129
129
130
-
This workflow will save the contents of your local Maven repository, located in the `.m2` directory of the runner's home directory. The cache key will be the hashed contents of _pom.xml_, so changes to _pom.xml_ will invalidate the cache.
130
+
This workflow will save the contents of your local Maven repository, located in the `.m2` directory of the runner's home directory. The cache key will be the hashed contents of `pom.xml`, so changes to `pom.xml` will invalidate the cache.
Copy file name to clipboardExpand all lines: content/actions/use-cases-and-examples/building-and-testing/building-and-testing-nodejs.md
+8-8
Original file line number
Diff line number
Diff line change
@@ -154,7 +154,7 @@ You can also cache dependencies to speed up your workflow. For more information,
154
154
155
155
### Example using npm
156
156
157
-
This example installs the versions in the _package-lock.json_ or _npm-shrinkwrap.json_ file and prevents updates to the lock file. Using `npm ci` is generally faster than running `npm install`. For more information, see [`npm ci`](https://docs.npmjs.com/cli/ci.html) and [Introducing `npm ci` for faster, more reliable builds](https://blog.npmjs.org/post/171556855892/introducing-npm-ci-for-faster-more-reliable).
157
+
This example installs the versions in the `package-lock.json` or `npm-shrinkwrap.json` file and prevents updates to the lock file. Using `npm ci` is generally faster than running `npm install`. For more information, see [`npm ci`](https://docs.npmjs.com/cli/ci.html) and [Introducing `npm ci` for faster, more reliable builds](https://blog.npmjs.org/post/171556855892/introducing-npm-ci-for-faster-more-reliable).
158
158
159
159
```yaml copy
160
160
steps:
@@ -167,7 +167,7 @@ steps:
167
167
run: npm ci
168
168
```
169
169
170
-
Using `npm install` installs the dependencies defined in the _package.json_ file. For more information, see [`npm install`](https://docs.npmjs.com/cli/install).
170
+
Using `npm install` installs the dependencies defined in the `package.json` file. For more information, see [`npm install`](https://docs.npmjs.com/cli/install).
171
171
172
172
```yaml copy
173
173
steps:
@@ -182,7 +182,7 @@ steps:
182
182
183
183
### Example using Yarn
184
184
185
-
This example installs the dependencies defined in the _yarn.lock_ file and prevents updates to the _yarn.lock_ file. For more information, see [`yarn install`](https://yarnpkg.com/en/docs/cli/install).
185
+
This example installs the dependencies defined in the `yarn.lock` file and prevents updates to the `yarn.lock` file. For more information, see [`yarn install`](https://yarnpkg.com/en/docs/cli/install).
186
186
187
187
```yaml copy
188
188
steps:
@@ -195,7 +195,7 @@ steps:
195
195
run: yarn --frozen-lockfile
196
196
```
197
197
198
-
Alternatively, you can install the dependencies defined in the _package.json_ file.
198
+
Alternatively, you can install the dependencies defined in the `package.json` file.
199
199
200
200
```yaml copy
201
201
steps:
@@ -214,9 +214,9 @@ steps:
214
214
215
215
To authenticate to your private registry, you'll need to store your npm authentication token as a secret. For example, create a repository secret called `NPM_TOKEN`. For more information, see [AUTOTITLE](/actions/security-guides/using-secrets-in-github-actions).
216
216
217
-
In the example below, the secret `NPM_TOKEN` stores the npm authentication token. The `setup-node` action configures the _.npmrc_ file to read the npm authentication token from the `NODE_AUTH_TOKEN` environment variable. When using the `setup-node` action to create an _.npmrc_ file, you must set the `NODE_AUTH_TOKEN` environment variable with the secret that contains your npm authentication token.
217
+
In the example below, the secret `NPM_TOKEN` stores the npm authentication token. The `setup-node` action configures the `.npmrc` file to read the npm authentication token from the `NODE_AUTH_TOKEN` environment variable. When using the `setup-node` action to create an `.npmrc` file, you must set the `NODE_AUTH_TOKEN` environment variable with the secret that contains your npm authentication token.
218
218
219
-
Before installing dependencies, use the `setup-node` action to create the _.npmrc_ file. The action has two input parameters. The `node-version` parameter sets the Node.js version, and the `registry-url` parameter sets the default registry. If your package registry uses scopes, you must use the `scope` parameter. For more information, see [`npm-scope`](https://docs.npmjs.com/misc/scope).
219
+
Before installing dependencies, use the `setup-node` action to create the `.npmrc` file. The action has two input parameters. The `node-version` parameter sets the Node.js version, and the `registry-url` parameter sets the default registry. If your package registry uses scopes, you must use the `scope` parameter. For more information, see [`npm-scope`](https://docs.npmjs.com/misc/scope).
220
220
221
221
```yaml copy
222
222
steps:
@@ -234,7 +234,7 @@ steps:
234
234
NODE_AUTH_TOKEN: {% raw %}${{ secrets.NPM_TOKEN }}{% endraw %}
235
235
```
236
236
237
-
The example above creates an _.npmrc_ file with the following contents:
237
+
The example above creates an `.npmrc` file with the following contents:
@@ -296,7 +296,7 @@ If you have a custom requirement or need finer controls for caching, you can use
296
296
297
297
## Building and testing your code
298
298
299
-
You can use the same commands that you use locally to build and test your code. For example, if you run `npm run build` to run build steps defined in your _package.json_ file and `npm test` to run your test suite, you would add those commands in your workflow file.
299
+
You can use the same commands that you use locally to build and test your code. For example, if you run `npm run build` to run build steps defined in your `package.json` file and `npm test` to run your test suite, you would add those commands in your workflow file.
Copy file name to clipboardExpand all lines: content/actions/use-cases-and-examples/building-and-testing/building-and-testing-python.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -233,7 +233,7 @@ steps:
233
233
234
234
### Requirements file
235
235
236
-
After you update `pip`, a typical next step is to install dependencies from _requirements.txt_. For more information, see [pip](https://pip.pypa.io/en/stable/cli/pip_install/#example-requirements-file).
236
+
After you update `pip`, a typical next step is to install dependencies from `requirements.txt`. For more information, see [pip](https://pip.pypa.io/en/stable/cli/pip_install/#example-requirements-file).
Copy file name to clipboardExpand all lines: content/actions/use-cases-and-examples/building-and-testing/building-and-testing-ruby.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -192,7 +192,7 @@ steps:
192
192
193
193
{% endraw %}
194
194
195
-
This will configure bundler to install your gems to `vendor/cache`. For each successful run of your workflow, this folder will be cached by {% data variables.product.prodname_actions %} and re-downloaded for subsequent workflow runs. A hash of your gemfile.lock and the Ruby version are used as the cache key. If you install any new gems, or change a version, the cache will be invalidated and bundler will do a fresh install.
195
+
This will configure bundler to install your gems to `vendor/cache`. For each successful run of your workflow, this folder will be cached by {% data variables.product.prodname_actions %} and re-downloaded for subsequent workflow runs. A hash of your `gemfile.lock` and the Ruby version are used as the cache key. If you install any new gems, or change a version, the cache will be invalidated and bundler will do a fresh install.
You can use the `setup-node` action to create a local _.npmrc_ file on the runner that configures the default registry and scope. The `setup-node` action also accepts an authentication token as input, used to access private registries or publish node packages. For more information, see [`setup-node`](https://github.com/actions/setup-node/).
1
+
You can use the `setup-node` action to create a local `.npmrc` file on the runner that configures the default registry and scope. The `setup-node` action also accepts an authentication token as input, used to access private registries or publish node packages. For more information, see [`setup-node`](https://github.com/actions/setup-node/).
0 commit comments