Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: compiler upgrades in Blueprint and other Tact projects #1560

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

novusnota
Copy link
Member

@verytactical Set the indentation in the showHelp to 2 spaces to align chunks of text better

Issue

Closes #1090.
Closes #71.

Checklist

  • I have updated CHANGELOG.md
  • I have run the linter, formatter and spellchecker
  • I did not do unrelated and/or undiscussed refactorings

@novusnota novusnota added this to the Doc: 2025-01 milestone Jan 24, 2025
@novusnota novusnota requested a review from a team as a code owner January 24, 2025 11:07
@anton-trunov anton-trunov changed the title Closes 1090 compiler upgrade Document compiler upgrades in Blueprint and other Tact projects Jan 24, 2025

Sometimes, bug fixes require us to change the existing behavior, introducing small breaking changes. To be prepared for these, make sure to read the [CHANGELOG.md](https://github.com/tact-lang/tact/blob/main/dev-docs/CHANGELOG.md) and act accordingly.

Except for bug fixes, Tact tries its best not to introduce breaking changes in minor or patch versions according to [semantic versioning](https://semver.org/#summary). And if there would be a major release that would significantly rework the language and its APIs, the Tact team will provide you with tools to patch the code itself, beyond the compiler upgrade commands shown above.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cannot promise that:

Suggested change
Except for bug fixes, Tact tries its best not to introduce breaking changes in minor or patch versions according to [semantic versioning](https://semver.org/#summary). And if there would be a major release that would significantly rework the language and its APIs, the Tact team will provide you with tools to patch the code itself, beyond the compiler upgrade commands shown above.
Except for bug fixes, Tact tries its best not to introduce breaking changes in minor or patch versions according to [semantic versioning](https://semver.org/#summary).

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, but weren't we planning such tool for the Tact 2.0?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We were, but we cannot promise it will work out


Work on the compiler is active and extensive, so be sure to check out [NPM](https://www.npmjs.com/package/@tact-lang/compiler) whenever we push new releases. To follow updates, see the [Tact Kitchen in Telegram](https://t.me/tact_kitchen) for the short scoop, or our [GitHub organization](https://github.com/tact-lang) for the whole picture in all its details.

To upgrade the Tact compiler to its latest version in a [Blueprint][bp]-based project or a project created from the [tact-template](https://github.com/tact-lang/tact-template), run:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's add how to set a specific Tact version

@anton-trunov
Copy link
Member

If it really closes #71, we should illustrate the error message

@anton-trunov anton-trunov self-assigned this Jan 24, 2025
@novusnota novusnota changed the title Document compiler upgrades in Blueprint and other Tact projects docs: compiler upgrades in Blueprint and other Tact projects Jan 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants