diff --git a/package-lock.json b/package-lock.json index 02c8763d66..dcfdf9bd49 100644 --- a/package-lock.json +++ b/package-lock.json @@ -100,7 +100,7 @@ "remark-directive": "^4.0.0", "remark-frontmatter": "^5.0.0", "remark-preset-lint-markdown-style-guide": "^6.0.1", - "sass-embedded": "^1.98.0", + "sass-embedded": "^1.99.0", "typescript": "^6.0.2", "unified": "^11.0.5", "unist-util-remove": "^4.0.0", @@ -14183,9 +14183,9 @@ } }, "node_modules/sass": { - "version": "1.98.0", - "resolved": "https://registry.npmjs.org/sass/-/sass-1.98.0.tgz", - "integrity": "sha512-+4N/u9dZ4PrgzGgPlKnaaRQx64RO0JBKs9sDhQ2pLgN6JQZ25uPQZKQYaBJU48Kd5BxgXoJ4e09Dq7nMcOUW3A==", + "version": "1.99.0", + "resolved": "https://registry.npmjs.org/sass/-/sass-1.99.0.tgz", + "integrity": "sha512-kgW13M54DUB7IsIRM5LvJkNlpH+WhMpooUcaWGFARkF1Tc82v9mIWkCbCYf+MBvpIUBSeSOTilpZjEPr2VYE6Q==", "license": "MIT", "optional": true, "dependencies": { @@ -14204,9 +14204,9 @@ } }, "node_modules/sass-embedded": { - "version": "1.98.0", - "resolved": "https://registry.npmjs.org/sass-embedded/-/sass-embedded-1.98.0.tgz", - "integrity": "sha512-Do7u6iRb6K+lrllcTkB1BXcHwOxcKe3rEfOF/GcCLE2w3WpddakRAosJOHFUR37DpsvimQXEt5abs3NzUjEIqg==", + "version": "1.99.0", + "resolved": "https://registry.npmjs.org/sass-embedded/-/sass-embedded-1.99.0.tgz", + "integrity": "sha512-gF/juR1aX02lZHkvwxdF80SapkQeg2fetoDF6gIQkNbSw5YEUFspMkyGTjPjgZSgIHuZpy+Wz4PlebKnLXMjdg==", "devOptional": true, "license": "MIT", "dependencies": { @@ -14225,30 +14225,30 @@ "node": ">=16.0.0" }, "optionalDependencies": { - "sass-embedded-all-unknown": "1.98.0", - "sass-embedded-android-arm": "1.98.0", - "sass-embedded-android-arm64": "1.98.0", - "sass-embedded-android-riscv64": "1.98.0", - "sass-embedded-android-x64": "1.98.0", - "sass-embedded-darwin-arm64": "1.98.0", - "sass-embedded-darwin-x64": "1.98.0", - "sass-embedded-linux-arm": "1.98.0", - "sass-embedded-linux-arm64": "1.98.0", - "sass-embedded-linux-musl-arm": "1.98.0", - "sass-embedded-linux-musl-arm64": "1.98.0", - "sass-embedded-linux-musl-riscv64": "1.98.0", - "sass-embedded-linux-musl-x64": "1.98.0", - "sass-embedded-linux-riscv64": "1.98.0", - "sass-embedded-linux-x64": "1.98.0", - "sass-embedded-unknown-all": "1.98.0", - "sass-embedded-win32-arm64": "1.98.0", - "sass-embedded-win32-x64": "1.98.0" + "sass-embedded-all-unknown": "1.99.0", + "sass-embedded-android-arm": "1.99.0", + "sass-embedded-android-arm64": "1.99.0", + "sass-embedded-android-riscv64": "1.99.0", + "sass-embedded-android-x64": "1.99.0", + "sass-embedded-darwin-arm64": "1.99.0", + "sass-embedded-darwin-x64": "1.99.0", + "sass-embedded-linux-arm": "1.99.0", + "sass-embedded-linux-arm64": "1.99.0", + "sass-embedded-linux-musl-arm": "1.99.0", + "sass-embedded-linux-musl-arm64": "1.99.0", + "sass-embedded-linux-musl-riscv64": "1.99.0", + "sass-embedded-linux-musl-x64": "1.99.0", + "sass-embedded-linux-riscv64": "1.99.0", + "sass-embedded-linux-x64": "1.99.0", + "sass-embedded-unknown-all": "1.99.0", + "sass-embedded-win32-arm64": "1.99.0", + "sass-embedded-win32-x64": "1.99.0" } }, "node_modules/sass-embedded-all-unknown": { - "version": "1.98.0", - "resolved": "https://registry.npmjs.org/sass-embedded-all-unknown/-/sass-embedded-all-unknown-1.98.0.tgz", - "integrity": "sha512-6n4RyK7/1mhdfYvpP3CClS3fGoYqDvRmLClCESS6I7+SAzqjxvGG6u5Fo+cb1nrPNbbilgbM4QKdgcgWHO9NCA==", + "version": "1.99.0", + "resolved": "https://registry.npmjs.org/sass-embedded-all-unknown/-/sass-embedded-all-unknown-1.99.0.tgz", + "integrity": "sha512-qPIRG8Uhjo6/OKyAKixTnwMliTz+t9K6Duk0mx5z+K7n0Ts38NSJz2sjDnc7cA/8V9Lb3q09H38dZ1CLwD+ssw==", "cpu": [ "!arm", "!arm64", @@ -14258,13 +14258,13 @@ "license": "MIT", "optional": true, "dependencies": { - "sass": "1.98.0" + "sass": "1.99.0" } }, "node_modules/sass-embedded-android-arm": { - "version": "1.98.0", - "resolved": "https://registry.npmjs.org/sass-embedded-android-arm/-/sass-embedded-android-arm-1.98.0.tgz", - "integrity": "sha512-LjGiMhHgu7VL1n7EJxTCre1x14bUsWd9d3dnkS2rku003IWOI/fxc7OXgaKagoVzok1kv09rzO3vFXJR5ZeONQ==", + "version": "1.99.0", + "resolved": "https://registry.npmjs.org/sass-embedded-android-arm/-/sass-embedded-android-arm-1.99.0.tgz", + "integrity": "sha512-EHvJ0C7/VuP78Qr6f8gIUVUmCqIorEQpw2yp3cs3SMg02ZuumlhjXvkTcFBxHmFdFR23vTNk1WnhY6QSeV1nFQ==", "cpu": [ "arm" ], @@ -14278,9 +14278,9 @@ } }, "node_modules/sass-embedded-android-arm64": { - "version": "1.98.0", - "resolved": "https://registry.npmjs.org/sass-embedded-android-arm64/-/sass-embedded-android-arm64-1.98.0.tgz", - "integrity": "sha512-M9Ra98A6vYJHpwhoC/5EuH1eOshQ9ZyNwC8XifUDSbRl/cGeQceT1NReR9wFj3L7s1pIbmes1vMmaY2np0uAKQ==", + "version": "1.99.0", + "resolved": "https://registry.npmjs.org/sass-embedded-android-arm64/-/sass-embedded-android-arm64-1.99.0.tgz", + "integrity": "sha512-fNHhdnP23yqqieCbAdym4N47AleSwjbNt6OYIYx4DdACGdtERjQB4iOX/TaKsW034MupfF7SjnAAK8w7Ptldtg==", "cpu": [ "arm64" ], @@ -14294,9 +14294,9 @@ } }, "node_modules/sass-embedded-android-riscv64": { - "version": "1.98.0", - "resolved": "https://registry.npmjs.org/sass-embedded-android-riscv64/-/sass-embedded-android-riscv64-1.98.0.tgz", - "integrity": "sha512-WPe+0NbaJIZE1fq/RfCZANMeIgmy83x4f+SvFOG7LhUthHpZWcOcrPTsCKKmN3xMT3iw+4DXvqTYOCYGRL3hcQ==", + "version": "1.99.0", + "resolved": "https://registry.npmjs.org/sass-embedded-android-riscv64/-/sass-embedded-android-riscv64-1.99.0.tgz", + "integrity": "sha512-4zqDFRvgGDTL5vTHuIhRxUpXFoh0Cy7Gm5Ywk19ASd8Settmd14YdPRZPmMxfgS1GH292PofV1fq1ifiSEJWBw==", "cpu": [ "riscv64" ], @@ -14310,9 +14310,9 @@ } }, "node_modules/sass-embedded-android-x64": { - "version": "1.98.0", - "resolved": "https://registry.npmjs.org/sass-embedded-android-x64/-/sass-embedded-android-x64-1.98.0.tgz", - "integrity": "sha512-zrD25dT7OHPEgLWuPEByybnIfx4rnCtfge4clBgjZdZ3lF6E7qNLRBtSBmoFflh6Vg0RlEjJo5VlpnTMBM5MQQ==", + "version": "1.99.0", + "resolved": "https://registry.npmjs.org/sass-embedded-android-x64/-/sass-embedded-android-x64-1.99.0.tgz", + "integrity": "sha512-Uk53k/dGYt04RjOL4gFjZ0Z9DH9DKh8IA8WsXUkNqsxerAygoy3zqRBS2zngfE9K2jiOM87q+1R1p87ory9oQQ==", "cpu": [ "x64" ], @@ -14326,9 +14326,9 @@ } }, "node_modules/sass-embedded-darwin-arm64": { - "version": "1.98.0", - "resolved": "https://registry.npmjs.org/sass-embedded-darwin-arm64/-/sass-embedded-darwin-arm64-1.98.0.tgz", - "integrity": "sha512-cgr1z9rBnCdMf8K+JabIaYd9Rag2OJi5mjq08XJfbJGMZV/TA6hFJCLGkr5/+ZOn4/geTM5/3aSfQ8z5EIJAOg==", + "version": "1.99.0", + "resolved": "https://registry.npmjs.org/sass-embedded-darwin-arm64/-/sass-embedded-darwin-arm64-1.99.0.tgz", + "integrity": "sha512-u61/7U3IGLqoO6gL+AHeiAtlTPFwJK1+964U8gp45ZN0hzh1yrARf5O1mivXv8NnNgJvbG2wWJbiNZP0lG/lTg==", "cpu": [ "arm64" ], @@ -14342,9 +14342,9 @@ } }, "node_modules/sass-embedded-darwin-x64": { - "version": "1.98.0", - "resolved": "https://registry.npmjs.org/sass-embedded-darwin-x64/-/sass-embedded-darwin-x64-1.98.0.tgz", - "integrity": "sha512-OLBOCs/NPeiMqTdOrMFbVHBQFj19GS3bSVSxIhcCq16ZyhouUkYJEZjxQgzv9SWA2q6Ki8GCqp4k6jMeUY9dcA==", + "version": "1.99.0", + "resolved": "https://registry.npmjs.org/sass-embedded-darwin-x64/-/sass-embedded-darwin-x64-1.99.0.tgz", + "integrity": "sha512-j/kkk/NcXdIameLezSfXjgCiBkVcA+G60AXrX768/3g0miK1g7M9dj7xOhCb1i7/wQeiEI3rw2LLuO63xRIn4A==", "cpu": [ "x64" ], @@ -14358,9 +14358,9 @@ } }, "node_modules/sass-embedded-linux-arm": { - "version": "1.98.0", - "resolved": "https://registry.npmjs.org/sass-embedded-linux-arm/-/sass-embedded-linux-arm-1.98.0.tgz", - "integrity": "sha512-03baQZCxVyEp8v1NWBRlzGYrmVT/LK7ZrHlF1piscGiGxwfdxoLXVuxsylx3qn/dD/4i/rh7Bzk7reK1br9jvQ==", + "version": "1.99.0", + "resolved": "https://registry.npmjs.org/sass-embedded-linux-arm/-/sass-embedded-linux-arm-1.99.0.tgz", + "integrity": "sha512-d4IjJZrX2+AwB2YCy1JySwdptJECNP/WfAQLUl8txI3ka8/d3TUI155GtelnoZUkio211PwIeFvvAeZ9RXPQnw==", "cpu": [ "arm" ], @@ -14374,9 +14374,9 @@ } }, "node_modules/sass-embedded-linux-arm64": { - "version": "1.98.0", - "resolved": "https://registry.npmjs.org/sass-embedded-linux-arm64/-/sass-embedded-linux-arm64-1.98.0.tgz", - "integrity": "sha512-axOE3t2MTBwCtkUCbrdM++Gj0gC0fdHJPrgzQ+q1WUmY9NoNMGqflBtk5mBZaWUeha2qYO3FawxCB8lctFwCtw==", + "version": "1.99.0", + "resolved": "https://registry.npmjs.org/sass-embedded-linux-arm64/-/sass-embedded-linux-arm64-1.99.0.tgz", + "integrity": "sha512-btNcFpItcB56L40n8hDeL7sRSMLDXQ56nB5h2deddJx1n60rpKSElJmkaDGHtpkrY+CTtDRV0FZDjHeTJddYew==", "cpu": [ "arm64" ], @@ -14390,9 +14390,9 @@ } }, "node_modules/sass-embedded-linux-musl-arm": { - "version": "1.98.0", - "resolved": "https://registry.npmjs.org/sass-embedded-linux-musl-arm/-/sass-embedded-linux-musl-arm-1.98.0.tgz", - "integrity": "sha512-OBkjTDPYR4hSaueOGIM6FDpl9nt/VZwbSRpbNu9/eEJcxE8G/vynRugW8KRZmCFjPy8j/jkGBvvS+k9iOqKV3g==", + "version": "1.99.0", + "resolved": "https://registry.npmjs.org/sass-embedded-linux-musl-arm/-/sass-embedded-linux-musl-arm-1.99.0.tgz", + "integrity": "sha512-2gvHOupgIw3ytatXT4nFUow71LFbuOZPEwG+HUzcNQDH8ue4Ez8cr03vsv5MDv3lIjOKcXwDvWD980t18MwkoQ==", "cpu": [ "arm" ], @@ -14406,9 +14406,9 @@ } }, "node_modules/sass-embedded-linux-musl-arm64": { - "version": "1.98.0", - "resolved": "https://registry.npmjs.org/sass-embedded-linux-musl-arm64/-/sass-embedded-linux-musl-arm64-1.98.0.tgz", - "integrity": "sha512-LeqNxQA8y4opjhe68CcFvMzCSrBuJqYVFbwElEj9bagHXQHTp9xVPJRn6VcrC+0VLEDq13HVXMv7RslIuU0zmA==", + "version": "1.99.0", + "resolved": "https://registry.npmjs.org/sass-embedded-linux-musl-arm64/-/sass-embedded-linux-musl-arm64-1.99.0.tgz", + "integrity": "sha512-Hi2bt/IrM5P4FBKz6EcHAlniwfpoz9mnTdvSd58y+avA3SANM76upIkAdSayA8ZGwyL3gZokru1AKDPF9lJDNw==", "cpu": [ "arm64" ], @@ -14422,9 +14422,9 @@ } }, "node_modules/sass-embedded-linux-musl-riscv64": { - "version": "1.98.0", - "resolved": "https://registry.npmjs.org/sass-embedded-linux-musl-riscv64/-/sass-embedded-linux-musl-riscv64-1.98.0.tgz", - "integrity": "sha512-7w6hSuOHKt8FZsmjRb3iGSxEzM87fO9+M8nt5JIQYMhHTj5C+JY/vcske0v715HCVj5e1xyTnbGXf8FcASeAIw==", + "version": "1.99.0", + "resolved": "https://registry.npmjs.org/sass-embedded-linux-musl-riscv64/-/sass-embedded-linux-musl-riscv64-1.99.0.tgz", + "integrity": "sha512-mKqGvVaJ9rHMqyZsF0kikQe4NO0f4osb67+X6nLhBiVDKvyazQHJ3zJQreNefIE36yL2sjHIclSB//MprzaQDg==", "cpu": [ "riscv64" ], @@ -14438,9 +14438,9 @@ } }, "node_modules/sass-embedded-linux-musl-x64": { - "version": "1.98.0", - "resolved": "https://registry.npmjs.org/sass-embedded-linux-musl-x64/-/sass-embedded-linux-musl-x64-1.98.0.tgz", - "integrity": "sha512-QikNyDEJOVqPmxyCFkci8ZdCwEssdItfjQFJB+D+Uy5HFqcS5Lv3d3GxWNX/h1dSb23RPyQdQc267ok5SbEyJw==", + "version": "1.99.0", + "resolved": "https://registry.npmjs.org/sass-embedded-linux-musl-x64/-/sass-embedded-linux-musl-x64-1.99.0.tgz", + "integrity": "sha512-huhgOMmOc30r7CH7qbRbT9LerSEGSnWuS4CYNOskr9BvNeQp4dIneFufNRGZ7hkOAxUM8DglxIZJN/cyAT95Ew==", "cpu": [ "x64" ], @@ -14454,9 +14454,9 @@ } }, "node_modules/sass-embedded-linux-riscv64": { - "version": "1.98.0", - "resolved": "https://registry.npmjs.org/sass-embedded-linux-riscv64/-/sass-embedded-linux-riscv64-1.98.0.tgz", - "integrity": "sha512-E7fNytc/v4xFBQKzgzBddV/jretA4ULAPO6XmtBiQu4zZBdBozuSxsQLe2+XXeb0X4S2GIl72V7IPABdqke/vA==", + "version": "1.99.0", + "resolved": "https://registry.npmjs.org/sass-embedded-linux-riscv64/-/sass-embedded-linux-riscv64-1.99.0.tgz", + "integrity": "sha512-mevFPIFAVhrH90THifxLfOntFmHtcEKOcdWnep2gJ0X4DVva4AiVIRlQe/7w9JFx5+gnDRE1oaJJkzuFUuYZsA==", "cpu": [ "riscv64" ], @@ -14470,9 +14470,9 @@ } }, "node_modules/sass-embedded-linux-x64": { - "version": "1.98.0", - "resolved": "https://registry.npmjs.org/sass-embedded-linux-x64/-/sass-embedded-linux-x64-1.98.0.tgz", - "integrity": "sha512-VsvP0t/uw00mMNPv3vwyYKUrFbqzxQHnRMO+bHdAMjvLw4NFf6mscpym9Bzf+NXwi1ZNKnB6DtXjmcpcvqFqYg==", + "version": "1.99.0", + "resolved": "https://registry.npmjs.org/sass-embedded-linux-x64/-/sass-embedded-linux-x64-1.99.0.tgz", + "integrity": "sha512-9k7IkULqIZdCIVt4Mboryt6vN8Mjmm3EhI1P3mClU5y5i3wLK5ExC3cbVWk047KsID/fvB1RLslqghXJx5BoxA==", "cpu": [ "x64" ], @@ -14486,9 +14486,9 @@ } }, "node_modules/sass-embedded-unknown-all": { - "version": "1.98.0", - "resolved": "https://registry.npmjs.org/sass-embedded-unknown-all/-/sass-embedded-unknown-all-1.98.0.tgz", - "integrity": "sha512-C4MMzcAo3oEDQnW7L8SBgB9F2Fq5qHPnaYTZRMOH3Mp/7kM4OooBInXpCiiFjLnjY95hzP4KyctVx0uYR6MYlQ==", + "version": "1.99.0", + "resolved": "https://registry.npmjs.org/sass-embedded-unknown-all/-/sass-embedded-unknown-all-1.99.0.tgz", + "integrity": "sha512-P7MxiUtL/XzGo3PX0CaB8lNNEFLQWKikPA8pbKytx9ZCLZSDkt2NJcdAbblB/sqMs4AV3EK2NadV8rI/diq3xg==", "license": "MIT", "optional": true, "os": [ @@ -14498,13 +14498,13 @@ "!win32" ], "dependencies": { - "sass": "1.98.0" + "sass": "1.99.0" } }, "node_modules/sass-embedded-win32-arm64": { - "version": "1.98.0", - "resolved": "https://registry.npmjs.org/sass-embedded-win32-arm64/-/sass-embedded-win32-arm64-1.98.0.tgz", - "integrity": "sha512-nP/10xbAiPbhQkMr3zQfXE4TuOxPzWRQe1Hgbi90jv2R4TbzbqQTuZVOaJf7KOAN4L2Bo6XCTRjK5XkVnwZuwQ==", + "version": "1.99.0", + "resolved": "https://registry.npmjs.org/sass-embedded-win32-arm64/-/sass-embedded-win32-arm64-1.99.0.tgz", + "integrity": "sha512-8whpsW7S+uO8QApKfQuc36m3P9EISzbVZOgC79goob4qGy09u8Gz/rYvw8h1prJDSjltpHGhOzBE6LDz7WvzVw==", "cpu": [ "arm64" ], @@ -14518,9 +14518,9 @@ } }, "node_modules/sass-embedded-win32-x64": { - "version": "1.98.0", - "resolved": "https://registry.npmjs.org/sass-embedded-win32-x64/-/sass-embedded-win32-x64-1.98.0.tgz", - "integrity": "sha512-/lbrVsfbcbdZQ5SJCWcV0NVPd6YRs+FtAnfedp4WbCkO/ZO7Zt/58MvI4X2BVpRY/Nt5ZBo1/7v2gYcQ+J4svQ==", + "version": "1.99.0", + "resolved": "https://registry.npmjs.org/sass-embedded-win32-x64/-/sass-embedded-win32-x64-1.99.0.tgz", + "integrity": "sha512-ipuOv1R2K4MHeuCEAZGpuUbAgma4gb0sdacyrTjJtMOy/OY9UvWfVlwErdB09KIkp4fPDpQJDJfvYN6bC8jeNg==", "cpu": [ "x64" ], diff --git a/package.json b/package.json index f8a6e6123b..b903ec258a 100644 --- a/package.json +++ b/package.json @@ -61,7 +61,7 @@ "remark-directive": "^4.0.0", "remark-frontmatter": "^5.0.0", "remark-preset-lint-markdown-style-guide": "^6.0.1", - "sass-embedded": "^1.98.0", + "sass-embedded": "^1.99.0", "typescript": "^6.0.2", "unified": "^11.0.5", "unist-util-remove": "^4.0.0", diff --git a/src/content/docs/ci-insights/setup/github-actions.mdx b/src/content/docs/ci-insights/setup/github-actions.mdx index b5d93e69d7..bb1868babb 100644 --- a/src/content/docs/ci-insights/setup/github-actions.mdx +++ b/src/content/docs/ci-insights/setup/github-actions.mdx @@ -142,10 +142,10 @@ jobs: running when no changes are made on the code - **Job name**: Ensure the job name is the same as the one running tests on your pull request, - allowing CI-Insights to identify them. It can be overriden with `MERGIFY_JOB_NAME` if needed. + allowing CI-Insights to identify them. It can be overridden with `MERGIFY_TEST_JOB_NAME` if needed. ### Key Environment Variables - `MERGIFY_TOKEN`: Application key with `ci` scope for uploading test results to CI Insights - `RUN_COUNT`: Number of times to execute each test within a single job -- `MERGIFY_JOB_NAME`: The job name reported to CI Insights +- `MERGIFY_TEST_JOB_NAME`: The job name reported to CI Insights diff --git a/src/content/docs/ci-insights/setup/jenkins.mdx b/src/content/docs/ci-insights/setup/jenkins.mdx index e8aa836df7..a72fcba151 100644 --- a/src/content/docs/ci-insights/setup/jenkins.mdx +++ b/src/content/docs/ci-insights/setup/jenkins.mdx @@ -162,10 +162,10 @@ pipeline { running when no changes are made on the code - **Job name**: Ensure the job name is the same as the one running tests on your pull request, - allowing CI-Insights to identify them. It can be overriden with `MERGIFY_JOB_NAME` if needed. + allowing CI-Insights to identify them. It can be overridden with `MERGIFY_TEST_JOB_NAME` if needed. ### Key Environment Variables - `MERGIFY_TOKEN`: Application key with `ci` scope for uploading test results to CI Insights - `RUN_COUNT`: Number of times to execute each test within a single job -- `MERGIFY_JOB_NAME`: The job name reported to CI Insights +- `MERGIFY_TEST_JOB_NAME`: The job name reported to CI Insights diff --git a/src/content/docs/ci-insights/test-frameworks/pytest.mdx b/src/content/docs/ci-insights/test-frameworks/pytest.mdx index 6153c8f1e7..56c65afda9 100644 --- a/src/content/docs/ci-insights/test-frameworks/pytest.mdx +++ b/src/content/docs/ci-insights/test-frameworks/pytest.mdx @@ -121,7 +121,7 @@ If you’re using multiple environments (e.g. `py38`, `py39`, etc.), the plugin will work for all of them as long as the token is set correctly. If you’re running multiple Tox environments (e.g., py38, py39, etc.), we -recommend setting the `MERGIFY_JOB_NAME` environment variable to identify each +recommend setting the `MERGIFY_TEST_JOB_NAME` environment variable to identify each environment’s report in CI Insights: In your GitHub Actions workflow: @@ -130,11 +130,11 @@ In your GitHub Actions workflow: - name: Run Tox Tests env: MERGIFY_TOKEN: ${{ secrets.MERGIFY_TOKEN }} - MERGIFY_JOB_NAME: tox-${{ matrix.python-version }} + MERGIFY_TEST_JOB_NAME: tox-${{ matrix.python-version }} run: tox ``` :::tip -Use `MERGIFY_JOB_NAME` to make reports clearer in CI Insights, especially when +Use `MERGIFY_TEST_JOB_NAME` to make reports clearer in CI Insights, especially when running multiple Tox environments or using a matrix. ::: diff --git a/src/content/docs/ci-insights/test-frameworks/rspec.mdx b/src/content/docs/ci-insights/test-frameworks/rspec.mdx index 09f3075b82..6690038f42 100644 --- a/src/content/docs/ci-insights/test-frameworks/rspec.mdx +++ b/src/content/docs/ci-insights/test-frameworks/rspec.mdx @@ -1,41 +1,31 @@ --- title: RSpec Integration with CI Insights -description: Report your test results from RSpec tests to CI Insights +description: Report your test results from RSpec to CI Insights --- import rspecLogo from "../../../images/ci-insights/rspec/logo.svg" -import CommonTroubleshootingTips from "./_common-troubleshooting-tips.mdx" -import GhaMergifyCiQuarantineSetup from "./_gha_mergify_ci_quarantine_setup.mdx" import IntegrationLogo from "../../../../components/IntegrationLogo.astro" -import MergifyCIUploadStep from "../../../../components/MergifyCIUploadStep.astro" import CIInsightsSetupNote from "../../../../components/CIInsightsSetupNote.astro" -import MergifyCIUploadStepMatrix from "../../../../components/MergifyCIUploadStepMatrix.astro" -This guide shows how to generate JUnit reports from your RSpec tests and upload -them to **CI Insights** using a GitHub Actions workflow. +This guide explains how to integrate RSpec with CI Insights using the +`rspec-mergify` gem. Once installed, test results are automatically uploaded to +CI Insights without any extra workflow changes. -## Generate a JUnit Report with RSpec +## Installation -RSpec supports JUnit XML output through the built-in JUnit formatter. You can -configure RSpec to output JUnit reports using command-line options or -configuration files. +You need to install the +[`rspec-mergify`](https://rubygems.org/gems/rspec-mergify) gem to automatically +upload your test results to **CI Insights**. -### Using Command Line Options +### Gemfile -```bash -bundle exec rspec --format RspecJunitFormatter --out junit.xml -``` - -### Installing the JUnit Formatter - -First, add the JUnit formatter gem to your Gemfile: +Add the gem to your `Gemfile`: ```ruby -# Gemfile group :test do - gem 'rspec-junit-formatter' + gem 'rspec-mergify' end ``` @@ -45,87 +35,96 @@ Then run: bundle install ``` -### Using RSpec Configuration +### Gem Install -Add the formatter to your `.rspec` file: +Alternatively, install it directly: -```text ---format RspecJunitFormatter ---out junit.xml +```bash +gem install rspec-mergify ``` -Or configure it in your `spec_helper.rb`: - -```ruby -# spec/spec_helper.rb -RSpec.configure do |config| - config.add_formatter('RspecJunitFormatter', 'junit.xml') -end -``` +## Modify Your Workflow -### Using Multiple Formatters + -You can use multiple formatters simultaneously: +Your workflow should run your tests as usual while exporting the secret +`MERGIFY_TOKEN` as an environment variable. You'll need to add the following +code to the GitHub Actions step running your tests: -```bash -bundle exec rspec --format documentation --format RspecJunitFormatter --out junit.xml +```yaml +env: + MERGIFY_TOKEN: ${{ secrets.MERGIFY_TOKEN }} ``` -### Using Rake Task +For example: -You can also create a Rake task in your `Rakefile`: - -```ruby -require 'rspec/core/rake_task' - -RSpec::Core::RakeTask.new(:spec_junit) do |t| - t.rspec_opts = '--format RspecJunitFormatter --out junit.xml' -end +```yaml +- name: Run RSpec Tests 🧪 + env: + MERGIFY_TOKEN: ${{ secrets.MERGIFY_TOKEN }} + run: bundle exec rspec ``` -Then run: +The gem automatically collects your test results and sends them to CI Insights. -```bash -bundle exec rake spec_junit -``` +Check the CI Insights dashboard afterward to view execution metrics, detect +flaky tests, and gather actionable feedback. -## Update Your GitHub Actions Workflow +## Environment Variables - +| Variable | Purpose | Default | +|----------|---------|---------| +| `MERGIFY_TOKEN` | API authentication token | **Required** | +| `MERGIFY_API_URL` | API endpoint location | `https://api.mergify.com` | +| `RSPEC_MERGIFY_ENABLE` | Force-enable outside CI | `false` | +| `RSPEC_MERGIFY_DEBUG` | Print spans to console | `false` | +| `MERGIFY_TRACEPARENT` | W3C distributed trace context | Optional | +| `MERGIFY_TEST_JOB_NAME` | Test job name identifier | Optional | -After generating the JUnit report, add a step to upload the results to CI -Insights using the mergifyio/gha-mergify-ci action. +:::tip +The gem auto-activates in CI environments (detected via the `CI` environment +variable). To enable it outside CI, set `RSPEC_MERGIFY_ENABLE=true`. +::: -For example, in your workflow file: +:::tip +Use `MERGIFY_TEST_JOB_NAME` to make reports clearer in CI Insights, especially +when running multiple test suites or using a matrix strategy. +::: -```yaml -- name: Run RSpec Tests and Generate JUnit Report - continue-on-error: true - run: bundle exec rspec --format RspecJunitFormatter --out junit.xml -``` +## Alternative: Manual JUnit XML Upload - - +If you prefer not to use the `rspec-mergify` gem, you can manually generate +JUnit XML reports and upload them using the Mergify CI action. - +### Generate a JUnit Report -## Verify and Review in CI Insights +Install the JUnit formatter gem: -After pushing these changes: +```ruby +# Gemfile +group :test do + gem 'rspec-junit-formatter' +end +``` -1. Your GitHub Actions workflow will execute your RSpec tests. -2. A JUnit report (junit.xml) is generated. -3. The Mergify CI action uploads the report to CI Insights. +Configure RSpec to output JUnit reports in your `.rspec` file: -You can then review your test results, including any failures or flaky tests, -directly in the [CI Insights -dashboard](https://dashboard.mergify.com/ci-insights/jobs). +```text +--format RspecJunitFormatter +--out junit.xml +``` -## Troubleshooting Tips +### Upload with GitHub Actions -
    -
  • Gem Installation: Ensure the `rspec-junit-formatter` gem is properly installed and included in your Gemfile.
    • -
  • RSpec Configuration: Verify that the formatter is correctly configured in your RSpec setup.
    • +```yaml +- name: Run RSpec Tests + continue-on-error: true + run: bundle exec rspec --format RspecJunitFormatter --out junit.xml - -
+- name: Upload test results to Mergify + if: success() || failure() + uses: mergifyio/gha-mergify-ci@v14 + with: + token: ${{ secrets.MERGIFY_TOKEN }} + report_path: "junit.xml" +```