jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-19 18:10:59 -05:00
Code Issues Projects Releases Wiki Activity

Update file and directory names to use backticks (#36059)

Browse Source
This commit is contained in:
Paulina Kalicka
2025-01-27 10:39:23 +01:00
committed by GitHub
parent de3564b2a5
commit 061b186ec0
7 changed files with 16 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
content/actions/use-cases-and-examples/building-and-testing/building-and-testing-java-with-ant.md
View File

@@ -90,9 +90,9 @@ We recommend that you have a basic understanding of Java and the Ant framework.
You can use the same commands that you use locally to build and test your code. You can use the same commands that you use locally to build and test your code.
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. 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.
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. 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.
```yaml copy ```yaml copy
steps: steps:

2
content/actions/use-cases-and-examples/building-and-testing/building-and-testing-java-with-gradle.md
View File

@@ -103,7 +103,7 @@ You can use the same commands that you use locally to build and test your code.
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. 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.
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. 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.
```yaml copy ```yaml copy
steps: steps:

4
content/actions/use-cases-and-examples/building-and-testing/building-and-testing-java-with-maven.md
View File

@@ -97,7 +97,7 @@ You can use the same commands that you use locally to build and test your code.
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. 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.
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. 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.
```yaml copy ```yaml copy
steps: steps:
@@ -127,7 +127,7 @@ steps:
run: mvn --batch-mode --update-snapshots verify run: mvn --batch-mode --update-snapshots verify
``` ```
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. 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.
## Packaging workflow data as artifacts ## Packaging workflow data as artifacts

16
content/actions/use-cases-and-examples/building-and-testing/building-and-testing-nodejs.md
View File

@@ -154,7 +154,7 @@ You can also cache dependencies to speed up your workflow. For more information,
### Example using npm ### Example using npm
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). 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).
```yaml copy ```yaml copy
steps: steps:
@@ -167,7 +167,7 @@ steps:
run: npm ci run: npm ci
``` ```
Using `npm install` installs the dependencies defined in the _package.json_ file. For more information, see [`npm install`](https://docs.npmjs.com/cli/install). Using `npm install` installs the dependencies defined in the `package.json` file. For more information, see [`npm install`](https://docs.npmjs.com/cli/install).
```yaml copy ```yaml copy
steps: steps:
@@ -182,7 +182,7 @@ steps:
### Example using Yarn ### Example using Yarn
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). 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).
```yaml copy ```yaml copy
steps: steps:
@@ -195,7 +195,7 @@ steps:
run: yarn --frozen-lockfile run: yarn --frozen-lockfile
``` ```
Alternatively, you can install the dependencies defined in the _package.json_ file. Alternatively, you can install the dependencies defined in the `package.json` file.
```yaml copy ```yaml copy
steps: steps:
@@ -214,9 +214,9 @@ steps:
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). 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).
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. 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.
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). 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).
```yaml copy ```yaml copy
steps: steps:
@@ -234,7 +234,7 @@ steps:
NODE_AUTH_TOKEN: {% raw %}${{ secrets.NPM_TOKEN }}{% endraw %} NODE_AUTH_TOKEN: {% raw %}${{ secrets.NPM_TOKEN }}{% endraw %}
``` ```
The example above creates an _.npmrc_ file with the following contents: The example above creates an `.npmrc` file with the following contents:
```shell ```shell
//registry.npmjs.org/:_authToken=${NODE_AUTH_TOKEN} //registry.npmjs.org/:_authToken=${NODE_AUTH_TOKEN}
@@ -296,7 +296,7 @@ If you have a custom requirement or need finer controls for caching, you can use
## Building and testing your code ## Building and testing your code
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. 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.
```yaml copy ```yaml copy
steps: steps:

2
content/actions/use-cases-and-examples/building-and-testing/building-and-testing-python.md
View File

@@ -233,7 +233,7 @@ steps:
### Requirements file ### Requirements file
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). 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).
```yaml copy ```yaml copy
steps: steps:

2
content/actions/use-cases-and-examples/building-and-testing/building-and-testing-ruby.md
View File

@@ -192,7 +192,7 @@ steps:
{% endraw %} {% endraw %}
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. 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.
**Caching without setup-ruby** **Caching without setup-ruby**

2
data/reusables/actions/setup-node-intro.md
View File

@@ -1 +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/). 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/).