name user-defined types by their module path

Author: leighmcculloch

.gitattributes

@@ -0,0 +1 @@
+.github/workflows/*.lock.yml linguist-generated=true merge=ours

.github/pull_request_template.md

@@ -9,3 +9,11 @@
 ### Known limitations
 
 [TODO or N/A]
+
+### SemVer Change
+
+[TODO: Check one. Merge only when confirmed that the main branch is accepting changes for the matching type of release. See the [semver-rules.md](./semver-rules.md).
+
+- [ ] Major (vX._._) - Breaking change to the public API.
+- [ ] Minor (v_.Y._) - Additive change to the public API.
+- [ ] Patch (v_._.Z) - No change to the public API.

.github/semver-rules.md

@@ -0,0 +1,55 @@
+# SemVer classification rules
+
+How to classify a change to the crates published from this repository, based on
+the [Cargo SemVer Compatibility reference](https://doc.rust-lang.org/cargo/reference/semver.html).
+
+A change is classified by the highest category any part of it falls into. If any
+single change is major, the whole change is major.
+
+## Major (vX._._) — breaking change to the public API
+
+- [Removing, renaming, or moving public items](https://doc.rust-lang.org/cargo/reference/semver.html#item-remove).
+- [Changing a trait's item signatures](https://doc.rust-lang.org/cargo/reference/semver.html#trait-item-signature), or [adding a non-defaulted trait item](https://doc.rust-lang.org/cargo/reference/semver.html#trait-new-item-no-default).
+- [Adding a field, public or private, to a struct whose fields are all public](https://doc.rust-lang.org/cargo/reference/semver.html#struct-add-public-field-when-no-private) and that isn't `non_exhaustive`. Once the struct has one private field, [adding more is minor](https://doc.rust-lang.org/cargo/reference/semver.html#struct-private-fields-with-private).
+- [Adding an enum variant](https://doc.rust-lang.org/cargo/reference/semver.html#enum-variant-new) to an enum that isn't `non_exhaustive`.
+- [Adding `non_exhaustive`](https://doc.rust-lang.org/cargo/reference/semver.html#attr-adding-non-exhaustive).
+- [Tightening generic bounds](https://doc.rust-lang.org/cargo/reference/semver.html#generic-bounds-tighten).
+- [Changing function arity](https://doc.rust-lang.org/cargo/reference/semver.html#fn-change-arity).
+- [Changing the alignment, layout, or size of a type that was previously well-defined](https://doc.rust-lang.org/cargo/reference/semver.html#type-layout): removing `repr(C)`, `repr(transparent)`, or an enum's `repr(<int>)`, or adding or changing `repr(packed)` or `repr(align)`. A type with the default representation guarantees no layout, so its size changing is not on its own major.
+- [Requiring `std` where `no_std` worked](https://doc.rust-lang.org/cargo/reference/semver.html#attr-no-std-to-std).
+- [Removing a Cargo feature](https://doc.rust-lang.org/cargo/reference/semver.html#cargo-feature-remove).
+
+## Minor (v_.Y._) — additive change to the public API
+
+- [Adding new public items](https://doc.rust-lang.org/cargo/reference/semver.html#item-new).
+- [Adding defaulted type parameters](https://doc.rust-lang.org/cargo/reference/semver.html#generic-new-default) or [defaulted trait parameters](https://doc.rust-lang.org/cargo/reference/semver.html#trait-new-parameter-default).
+- [Loosening generic bounds](https://doc.rust-lang.org/cargo/reference/semver.html#generic-bounds-loosen) or [generalizing to more generic types](https://doc.rust-lang.org/cargo/reference/semver.html#generic-more-generic).
+- [Making an `unsafe` function safe](https://doc.rust-lang.org/cargo/reference/semver.html#fn-unsafe-safe).
+- [Adding private struct fields when one already exists](https://doc.rust-lang.org/cargo/reference/semver.html#struct-private-fields-with-private).
+- [Adding a Cargo feature](https://doc.rust-lang.org/cargo/reference/semver.html#cargo-feature-add) or [dependency](https://doc.rust-lang.org/cargo/reference/semver.html#cargo-dep-add).
+- The [possibly-breaking changes](https://doc.rust-lang.org/cargo/reference/semver.html#possibly-breaking-changes), such as [raising the minimum supported Rust version](https://doc.rust-lang.org/cargo/reference/semver.html#env-new-rust), [adding a defaulted trait item](https://doc.rust-lang.org/cargo/reference/semver.html#trait-new-default-item), or [adding inherent items](https://doc.rust-lang.org/cargo/reference/semver.html#impl-item-new).
+
+## Patch (v_._.Z) — no change to the public API
+
+- Bug fixes that preserve documented behavior.
+- Performance improvements.
+- Internal refactors and private item changes.
+- Documentation, example, test, or CI changes.
+- Dependency patch bumps.
+
+## Applying the rules to this repository
+
+The crates in the top level directories are published and are the ones being
+classified. The crates under `tests/` are test vectors and are not published.
+
+The public API of the SDK includes the code that the macros in
+`soroban-sdk-macros` generate. A change to what `#[contract]`,
+`#[contractimpl]`, `#[contracttype]`, or the other macros emit can break
+contracts that build against the SDK, or change the contract spec and events a
+built contract exposes, even when no Rust item in the SDK itself changes.
+`tests-expanded/` holds the generated code for the test vectors, so a diff there
+is evidence that the generated API changed, and it is classified by what the
+change does to a contract that uses it.
+
+Changes confined to `tests/`, `.github/`, the `Makefile`, or the repository's
+documentation are patch.

.github/workflows/rust.yml

@@ -22,7 +22,7 @@ jobs:
 
   complete:
     if: always()
-    needs: [fmt, check-git-rev-deps, semver-checks, build, test, expand-test-wasms, build-fuzz, docs, readme, migration-docs]
+    needs: [fmt, check-git-rev-deps, build, test, expand-test-wasms, build-fuzz, docs, readme, migration-docs]
     runs-on: ubuntu-slim
     steps:
     - if: contains(needs.*.result, 'failure') || contains(needs.*.result, 'cancelled')
@@ -96,41 +96,6 @@ jobs:
     - uses: actions/checkout@v3
     - uses: stellar/actions/rust-check-git-rev-deps@main
 
-  semver-checks:
-    # Push and merge queue events do not include PR labels, so only check pull request events.
-    if: "github.event_name == 'pull_request' && !contains(github.event.pull_request.labels.*.name, 'skip-semver-checks')"
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v3
-    - run: rustup update stable
-    - name: Determine Rust n-2 version since cargo-semver-checks is rarely available for the latest version
-      id: rust-version
-      run: |
-        current_version=$(rustc +stable --version | grep -oE '[0-9]+\.[0-9]+' | head -1)
-        major=$(echo $current_version | cut -d. -f1)
-        minor=$(echo $current_version | cut -d. -f2)
-        prev_minor=$((minor - 2))
-        prev_version="${major}.${prev_minor}"
-        echo "Latest stable: $current_version, using n-2: $prev_version"
-        echo "version=$prev_version" >> $GITHUB_OUTPUT
-    - name: Install Rust ${{ steps.rust-version.outputs.version }}
-      run: |
-        rustup install ${{ steps.rust-version.outputs.version }}
-        rustup override set ${{ steps.rust-version.outputs.version }}
-    - name: Verify Rust version
-      run: |
-        rustc --version
-        cargo --version
-    - uses: stellar/binaries@v55
-      with:
-        name: cargo-semver-checks
-        version: 0.46.0
-    - run: >
-        cargo semver-checks
-        --exclude soroban-meta
-        --exclude soroban-token-spec
-        --exclude stellar-asset-spec
-
   build:
     needs: setup
     strategy: