mirror of
https://github.com/FuelLabs/sway.git
synced 2025-08-08 20:58:27 +00:00
3b5e7a8d9b
Some checks are pending
Codspeed Benchmarks / benchmarks (push) Waiting to run
CI / verifications-complete (push) Blocked by required conditions
CI / check-dependency-version-formats (push) Waiting to run
CI / check-forc-manifest-version (push) Waiting to run
CI / get-fuel-core-version (push) Waiting to run
CI / cargo-test-forc (push) Waiting to run
CI / cargo-test-workspace (push) Waiting to run
CI / cargo-unused-deps-check (push) Waiting to run
CI / notify-slack-on-failure (push) Blocked by required conditions
CI / pre-publish-check (push) Waiting to run
CI / publish (push) Blocked by required conditions
CI / publish-sway-lib-std (push) Blocked by required conditions
CI / build-sway-lib-std (push) Waiting to run
CI / build-sway-examples (push) Waiting to run
CI / build-reference-examples (push) Waiting to run
CI / forc-fmt-check-sway-lib-std (push) Waiting to run
CI / forc-fmt-check-sway-examples (push) Waiting to run
CI / forc-fmt-check-panic (push) Waiting to run
CI / check-sdk-harness-test-suite-compatibility (push) Waiting to run
CI / build-mdbook (push) Waiting to run
CI / build-forc-doc-sway-lib-std (push) Waiting to run
CI / build-forc-test-project (push) Waiting to run
CI / cargo-build-workspace (push) Waiting to run
CI / cargo-clippy (push) Waiting to run
CI / cargo-toml-fmt-check (push) Waiting to run
CI / cargo-fmt-check (push) Waiting to run
CI / cargo-run-e2e-test (push) Blocked by required conditions
CI / cargo-run-e2e-test-release (push) Blocked by required conditions
CI / cargo-run-e2e-test-evm (push) Waiting to run
CI / cargo-test-lib-std (push) Waiting to run
CI / forc-run-benchmarks (push) Waiting to run
CI / forc-unit-tests (push) Waiting to run
CI / forc-pkg-fuels-deps-check (push) Waiting to run
CI / cargo-test-forc-debug (push) Blocked by required conditions
CI / cargo-test-forc-client (push) Blocked by required conditions
CI / cargo-test-forc-node (push) Blocked by required conditions
CI / cargo-test-sway-lsp (push) Waiting to run
CI / Build and upload forc binaries to release (push) Blocked by required conditions
github pages / deploy (push) Waiting to run
## Description This PR: - Adds a new "Error handling" page to "Sway Language Basics". - Updates all references to ABI errors. - Extends the "Breaking Release Checklist" with documentation related checks. ## Checklist - [ ] I have linked to any relevant issues. - [ ] I have commented my code, particularly in hard-to-understand areas. - [x] I have updated the documentation where relevant (API docs, the reference, and the Sway book). - [x] If my change requires substantial documentation changes, I have [requested support from the DevRel team](https://github.com/FuelLabs/devrel-requests/issues/new/choose) - [ ] I have added tests that prove my fix is effective or that my feature works. - [ ] I have added (or requested a maintainer to add) the necessary `Breaking*` or `New Feature` labels where relevant. - [x] I have done my best to ensure that my PR adheres to [the Fuel Labs Code Review Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md). - [x] I have requested a review from the relevant team or maintainers.
14 lines
1.1 KiB
Markdown
14 lines
1.1 KiB
Markdown
# Breaking Release Checklist
|
|
|
|
- [ ] Ensure that the `forc migrate` tool **in the latest patch release before the breaking change release** contains all migration steps.
|
|
- [ ] Promote experimental features to standard features:
|
|
- [ ] Remove feature flags and all conditional code from the compiler.
|
|
- [ ] Remove experimental `cfg` attributes from all the Sway codebase in the `sway` repository. (E.g., `std` library, E2E tests, in-language tests, etc.)
|
|
- [ ] Remove testing experimental features from E2E tests by deleting all the `test.<feature>.toml` files.
|
|
- [ ] Remove testing experimental features from `ci.yml`.
|
|
- [ ] Close the GitHub tracking issues.
|
|
- [ ] In the breaking change release, unregister all the migration steps in the `forc migrate`. (Do not delete the migrations. We want to keep them as examples for similar future migrations and for learning purposes.)
|
|
- [ ] Update documentation;
|
|
- [ ] Ensure that the experimental feature itself is fully documented.
|
|
- [ ] Ensure that all _Notes_ describing the feature as experimental are removed.
|
|
- [ ] Ensure that all related documentation is updated.
|