8000 revert: docs: repared broken links to "CI configuration recipes" · semantic-release/semantic-release@e00b6c8 · GitHub
[go: up one dir, main page]

Skip to content

Commit e00b6c8

Browse files
committed
revert: docs: repared broken links to "CI configuration recipes"
This reverts commit 3f22978.
1 parent 3c4a0fb commit e00b6c8

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

docs/support/FAQ.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ If your CI environment provides [nvm](https://github.com/creationix/nvm) you can
5656
$ nvm install 8 && yarn global add semantic-release && semantic-release
5757
```
5858

59-
See the [CI configuration recipes](../recipes/ci-configurations.md) for more details on specific CI environments.
59+
See the [CI configuration recipes](../recipes/README.md#ci-configurations) for more details on specific CI environments.
6060

6161
As `semantic-release` is recommended to be executed with [`npx`](https://www.npmjs.com/package/npx) an alternative is required for usage with Yarn. Even though it is possible to install npx with Yarn, it's not recommended. Yarn and npx would be using different cache locations.
6262

@@ -75,7 +75,7 @@ To publish a non-Node package (without a `package.json`) you would need to:
7575
- Set **semantic-release** [options](../usage/configuration.md#options) via [CLI arguments or rc file](../usage/configuration.md#configuration)
7676
- Make sure your CI job executing the `semantic-release` command has access to [Node >= 8](#why-does-semantic-release-require-node-version--83) to execute the `semantic-release` command
7777

78-
See the [CI configuration recipes](../recipes/ci-configurations.md) for more details on specific CI environments.
78+
See the [CI configuration recipes](../recipes/README.md#ci-configurations) for more details on specific CI environments.
7979

8080
In addition you will need to configure the **semantic-release** [plugins](../usage/plugins.md#plugins) to disable the [`@semantic-release/npm`](https://github.com/semantic-release/npm) plugin which is used by default and use a plugin for your project type.
8181

@@ -107,7 +107,7 @@ Yes, **semantic-release** can be used with any CI service, as long as it provide
107107
- A way to set [authentication](../usage/ci-configuration.md#authentication) via environment variables
108108
- A way to guarantee that the `semantic-release` command is [executed only after all the tests of all the jobs in the CI build pass](../usage/ci-configuration.md#run-semantic-release-only-after-all-tests-succeeded)
109109

110-
See the [CI configuration recipes](../recipes/ci-configurations.md) for more details on specific CI environments.
110+
See the [CI configuration recipes](../recipes/README.md#ci-configurations) for more details on specific CI environments.
111111

112112
## Can I run semantic-release on my local machine rather than on a CI server?
113113

docs/support/node-version.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ See our [Node Support Policy](node-support-policy.md) for our long-term promise
1212

1313
The recommended approach is to run the `semantic-release` command from a CI job running on Node 8.3 or higher. This can either be a job used by your project to test on Node >= 8.3 or a dedicated job for the release steps.
1414

15-
See [CI configuration](../usage/ci-configuration.md) and [CI configuration recipes](../recipes/ci-configurations.md) for more details.
15+
See [CI configuration](../usage/ci-configuration.md) and [CI configuration recipes](../recipes/README.md#ci-configurations) for more details.
1616

1717
## Alternative solutions
1818

docs/usage/ci-configuration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
The `semantic-release` command must be executed only after all the tests in the CI build pass. If the build runs multiple jobs (for example to test on multiple Operating Systems or Node versions) the CI has to be configured to guarantee that the `semantic-release` command is executed only after all jobs are successful. This can be achieved with [Travis Build Stages](https://docs.travis-ci.com/user/build-stages), [CircleCI Workflows](https://circleci.com/docs/2.0/workflows), [Codeship Deployment Pipelines](https://documentation.codeship.com/basic/builds-and-configuration/deployment-pipelines), [GitLab Pipelines](https://docs.gitlab.com/ee/ci/pipelines.html#introduction-to-pipelines-and-jobs), [Codefresh Pipelines](https://codefresh.io/docs/docs/configure-ci-cd-pipeline/introduction-to-codefresh-pipelines), [Wercker Workflows](http://devcenter.wercker.com/docs/workflows) or [GoCD Pipelines](https://docs.gocd.org/current/introduction/concepts_in_go.html#pipeline).
66

7-
See [CI configuration recipes](../recipes/ci-configurations.md) for more details.
7+
See [CI configuration recipes](../recipes/README.md#ci-configurations) for more details.
88

99
## Authentication
1010

@@ -30,4 +30,4 @@ See each plugin's documentation for the environment variables required.
3030

3131
The authentication token/credentials have to be made available in the CI service via environment variables.
3232

33-
See [CI configuration recipes](../recipes/ci-configurations.md) for more details on how to configure environment variables in your CI service.
33+
See [CI configuration recipes](../recipes/README.md#ci-configurations) for more details on how to configure environment variables in your CI service.

0 commit comments

Comments
 (0)
0