Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion source/guides/dashboard/github-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,9 @@ The Cypress Dashboard can integrate your Cypress tests with your GitHub workflow
{% note info %}
GitHub Enterprise is currently not supported. Please [contact us](mailto:[email protected]) if you are interested in Enterprise integration.
{% endnote %}

{% note warning %}
GitHub Integration is dependent on your CI environment reliably providing commit SHA data (typically via an environment variable). This is not a problem for most users, but please [contact us](mailto:[email protected]) if you are facing GitHub integration issues with your CI setup.
GitHub Integration is dependent on your CI environment reliably providing commit SHA data (typically via an environment variable). This is not a problem for most users, but if you are facing GitHub integration issues with your CI setup, please make sure the git information is being sent properly by following {% url "these guidelines" continuous-integration#Git-information %}. If you are still facing issues after this, please [contact us](mailto:[email protected]).
{% endnote %}

## Install the Cypress GitHub app
Expand Down
8 changes: 7 additions & 1 deletion source/guides/guides/continuous-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -412,7 +412,7 @@ Typically you'd set this inside of your CI provider.

### Git information

Cypress uses the {% url 'commit-info' https://github.com/cypress-io/commit-info %} package to extract git information to associate with the run (e.g. branch, commit message, author).
Cypress uses the {% url '@cypress/commit-info' https://github.com/cypress-io/commit-info %} package to extract git information to associate with the run (e.g. branch, commit message, author).

It assumes there is a `.git` folder and uses Git commands to get each property, like `git show -s --pretty=%B` to get commit message, see {% url 'src/git-api.js' https://github.com/cypress-io/commit-info/blob/master/src/git-api.js %}.

Expand All @@ -425,6 +425,12 @@ Under some environment setups (e.g. `docker`/`docker-compose`) if the `.git` dir
- SHA: `COMMIT_INFO_SHA`
- Remote: `COMMIT_INFO_REMOTE`

If the commit information is missing in the Dashboard run then {% url "GitHub Integration" github-integration %} or other tasks might not work correctly. To see the relevant Cypress debug logs, set the environment variable `DEBUG` on your CI machine and inspect the terminal output to see why the commit information is unavailable.

```shell
DEBUG=commit-info,cypress:server:record
```

### Custom Environment Variables

You can also set custom environment variables for use in your tests. These enable your code to reference dynamic values.
Expand Down
3 changes: 2 additions & 1 deletion source/ja/guides/dashboard/github-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,9 @@ The Cypress Dashboard can integrate your Cypress tests with your GitHub workflow
{% note info %}
GitHub Enterprise is currently not supported. Please [contact us](mailto:[email protected]) if you are interested in Enterprise integration.
{% endnote %}

{% note warning %}
GitHub Integration is dependent on your CI environment reliably providing commit SHA data (typically via an environment variable). This is not a problem for most users, but please [contact us](mailto:[email protected]) if you are facing GitHub integration issues with your CI setup.
GitHub Integration is dependent on your CI environment reliably providing commit SHA data (typically via an environment variable). This is not a problem for most users, but if you are facing GitHub integration issues with your CI setup, please make sure the git information is being sent properly by following {% url "these guidelines" continuous-integration#Git-information %}. If you are still facing issues after this, please [contact us](mailto:[email protected]).
{% endnote %}

## Install the Cypress GitHub app
Expand Down
8 changes: 7 additions & 1 deletion source/ja/guides/guides/continuous-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -388,7 +388,7 @@ Typically you'd set this inside of your CI provider.

### Git information

Cypress uses the {% url 'commit-info' https://github.com/cypress-io/commit-info %} package to extract git information to associate with the run (e.g. branch, commit message, author).
Cypress uses the {% url '@cypress/commit-info' https://github.com/cypress-io/commit-info %} package to extract git information to associate with the run (e.g. branch, commit message, author).

It assumes there is a `.git` folder and uses Git commands to get each property, like `git show -s --pretty=%B` to get commit message, see {% url 'src/git-api.js' https://github.com/cypress-io/commit-info/blob/master/src/git-api.js %}.

Expand All @@ -401,6 +401,12 @@ Under some environment setups (e.g. `docker`/`docker-compose`) if the `.git` dir
- SHA: `COMMIT_INFO_SHA`
- Remote: `COMMIT_INFO_REMOTE`

If the commit information is missing in the Dashboard run then {% url "GitHub Integration" github-integration %} or other tasks might not work correctly. To see the relevant Cypress debug logs, set the environment variable `DEBUG` on your CI machine and inspect the terminal output to see why the commit information is unavailable.

```shell
DEBUG=commit-info,cypress:server:record
```

### Custom Environment Variables

You can also set custom environment variables for use in your tests. These enable your code to reference dynamic values.
Expand Down
3 changes: 2 additions & 1 deletion source/zh-cn/guides/dashboard/github-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,9 @@ The Cypress Dashboard can integrate your Cypress tests with your GitHub workflow
{% note info %}
GitHub Enterprise is currently not supported. Please [contact us](mailto:[email protected]) if you are interested in Enterprise integration.
{% endnote %}

{% note warning %}
GitHub Integration is dependent on your CI environment reliably providing commit SHA data (typically via an environment variable). This is not a problem for most users, but please [contact us](mailto:[email protected]) if you are facing GitHub integration issues with your CI setup.
GitHub Integration is dependent on your CI environment reliably providing commit SHA data (typically via an environment variable). This is not a problem for most users, but if you are facing GitHub integration issues with your CI setup, please make sure the git information is being sent properly by following {% url "these guidelines" continuous-integration#Git-information %}. If you are still facing issues after this, please [contact us](mailto:[email protected]).
{% endnote %}

## Install the Cypress GitHub app
Expand Down
8 changes: 7 additions & 1 deletion source/zh-cn/guides/guides/continuous-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -388,7 +388,7 @@ cypress run --record

### Git信息

Cypress使用{% url 'commit-info' https://github.com/cypress-io/commit-info %}包来获取git信息并关联到运行时(比如分支信息、提交信息、作者等)。
Cypress使用{% url '@cypress/commit-info' https://github.com/cypress-io/commit-info %}包来获取git信息并关联到运行时(比如分支信息、提交信息、作者等)。

它默认有一个`.git`的目录,并使用Git命令去获取各个信息,比如`git show -s --pretty=%B`来获取提交信息,参考{% url 'src/git-api.js' https://github.com/cypress-io/commit-info/blob/master/src/git-api.js %}。

Expand All @@ -401,6 +401,12 @@ Cypress使用{% url 'commit-info' https://github.com/cypress-io/commit-info %}
- SHA: `COMMIT_INFO_SHA`
- Remote: `COMMIT_INFO_REMOTE`

If the commit information is missing in the Dashboard run then {% url "GitHub Integration" github-integration %} or other tasks might not work correctly. To see the relevant Cypress debug logs, set the environment variable `DEBUG` on your CI machine and inspect the terminal output to see why the commit information is unavailable.

```shell
DEBUG=commit-info,cypress:server:record
```

### 自定义环境变量

测试时你可以设置自定义的环境变量,这使你的代码可以引用动态值:
Expand Down