summaryrefslogtreecommitdiff
path: root/tool/rbs_skip_tests
diff options
context:
space:
mode:
authorSoutaro Matsumoto <matsumoto@soutaro.com>2023-03-20 10:39:17 +0900
committerGitHub <noreply@github.com>2023-03-20 10:39:17 +0900
commit615f42fd61392dbe40f5232138566313b02a14df (patch)
tree887ec434bd80967446db292a88857493527069f5 /tool/rbs_skip_tests
parent2f29044de48ed3f468c09ea3c5c214791370037f (diff)
downloadruby-615f42fd61392dbe40f5232138566313b02a14df.tar.gz
Add explanation to rbs_skip_tests (#7525)
Diffstat (limited to 'tool/rbs_skip_tests')
-rw-r--r--tool/rbs_skip_tests20
1 files changed, 19 insertions, 1 deletions
diff --git a/tool/rbs_skip_tests b/tool/rbs_skip_tests
index 477ba6f9dd..e3173d3844 100644
--- a/tool/rbs_skip_tests
+++ b/tool/rbs_skip_tests
@@ -1,7 +1,25 @@
+# Running tests of RBS gem may fail because of various reasons.
+# You can skip tests of RBS gem using this file, instead of pushing a new commit to `ruby/rbs` repository.
+#
+# The most frequently seen reason is the incompatibilities introduced to the unreleased version, including
+#
+# * Strict argument type check is introduced
+# * A required method parameter is added
+# * A method/class is removed
+#
+# Feel free to skip the tests with this file for that case.
+#
+# Syntax:
+#
+# $(test-case-name) ` ` $(optional comment) # Skipping single test case
+# $(test-class-name) ` ` $(optional comment) # Skipping a test class
+#
+
+test_replicate(EncodingTest) the method was removed in 3.3
+
test_collection_install(RBS::CliTest) running tests without Bundler
test_collection_install_frozen(RBS::CliTest) running tests without Bundler
test_collection_update(RBS::CliTest) running tests without Bundler
-test_replicate(EncodingTest) the method was removed in 3.3
NetSingletonTest depending on external resources
NetInstanceTest depending on external resources