summaryrefslogtreecommitdiffstats
path: root/cmd/gorelease/testdata/basic/README.txt
diff options
context:
space:
mode:
Diffstat (limited to 'cmd/gorelease/testdata/basic/README.txt')
-rw-r--r--cmd/gorelease/testdata/basic/README.txt11
1 files changed, 11 insertions, 0 deletions
diff --git a/cmd/gorelease/testdata/basic/README.txt b/cmd/gorelease/testdata/basic/README.txt
new file mode 100644
index 0000000..708a0c1
--- /dev/null
+++ b/cmd/gorelease/testdata/basic/README.txt
@@ -0,0 +1,11 @@
+Module example.com/basic tests basic functionality of gorelease.
+It verifies that versions are correctly suggested or verified after
+various changes.
+
+All revisions are stored in the mod directory. The same series of
+changes is made across three major versions, v0, v1, and v2:
+
+vX.0.1 - simple package
+vX.1.0 - compatible change: add a function and a package
+vX.1.1 - internal change: function returns different value
+vX.1.2 - incompatible change: delete a function and a package