From e00b6c84df7c4c77dd95681c6fb2093e38de1088 Mon Sep 17 00:00:00 2001 From: Pierre Vanduynslager Date: Thu, 22 Aug 2019 12:11:14 -0400 Subject: [PATCH] revert: docs: repared broken links to "CI configuration recipes" This reverts commit 3f229786233e87a4e5e8d1d812a23cc7edc98bb2. --- docs/support/FAQ.md | 6 +++--- docs/support/node-version.md | 2 +- docs/usage/ci-configuration.md | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/support/FAQ.md b/docs/support/FAQ.md index f323443e29..bb70011695 100644 --- a/docs/support/FAQ.md +++ b/docs/support/FAQ.md @@ -56,7 +56,7 @@ If your CI environment provides [nvm](https://github.com/creationix/nvm) you can $ nvm install 8 && yarn global add semantic-release && semantic-release ``` -See the [CI configuration recipes](../recipes/ci-configurations.md) for more details on specific CI environments. +See the [CI configuration recipes](../recipes/README.md#ci-configurations) for more details on specific CI environments. 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. @@ -75,7 +75,7 @@ To publish a non-Node package (without a `package.json`) you would need to: - Set **semantic-release** [options](../usage/configuration.md#options) via [CLI arguments or rc file](../usage/configuration.md#configuration) - 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 -See the [CI configuration recipes](../recipes/ci-configurations.md) for more details on specific CI environments. +See the [CI configuration recipes](../recipes/README.md#ci-configurations) for more details on specific CI environments. 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. @@ -107,7 +107,7 @@ Yes, **semantic-release** can be used with any CI service, as long as it provide - A way to set [authentication](../usage/ci-configuration.md#authentication) via environment variables - 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) -See the [CI configuration recipes](../recipes/ci-configurations.md) for more details on specific CI environments. +See the [CI configuration recipes](../recipes/README.md#ci-configurations) for more details on specific CI environments. ## Can I run semantic-release on my local machine rather than on a CI server? diff --git a/docs/support/node-version.md b/docs/support/node-version.md index e387685b23..542af90b4b 100644 --- a/docs/support/node-version.md +++ b/docs/support/node-version.md @@ -12,7 +12,7 @@ See our [Node Support Policy](node-support-policy.md) for our long-term promise 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. -See [CI configuration](../usage/ci-configuration.md) and [CI configuration recipes](../recipes/ci-configurations.md) for more details. +See [CI configuration](../usage/ci-configuration.md) and [CI configuration recipes](../recipes/README.md#ci-configurations) for more details. ## Alternative solutions diff --git a/docs/usage/ci-configuration.md b/docs/usage/ci-configuration.md index 036d287b82..ef2c72927e 100644 --- a/docs/usage/ci-configuration.md +++ b/docs/usage/ci-configuration.md @@ -4,7 +4,7 @@ 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). -See [CI configuration recipes](../recipes/ci-configurations.md) for more details. +See [CI configuration recipes](../recipes/README.md#ci-configurations) for more details. ## Authentication @@ -30,4 +30,4 @@ See each plugin's documentation for the environment variables required. The authentication token/credentials have to be made available in the CI service via environment variables. -See [CI configuration recipes](../recipes/ci-configurations.md) for more details on how to configure environment variables in your CI service. +See [CI configuration recipes](../recipes/README.md#ci-configurations) for more details on how to configure environment variables in your CI service.