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.

Sign up for GitHub

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

feat: Version Control and Tagging (Packages) #2842

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

feat: Version Control and Tagging (Packages) #2842

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
37cc730
feat: Version Control and Tagging (Packages)
harshilp24 Mar 20, 2025
524a770
..
harshilp24 Mar 20, 2025
48c44d3
..
harshilp24 Mar 20, 2025
2299477
...
harshilp24 Mar 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion website/docs/packages/how-to-guides/pass-date-between-modules.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,13 @@ export default {



3. Publish the package.
3. **Publish** the Package from top-right corner. This allows the changes to reflect on the app side.

<dd>

If the package is git-connected, you also need to release a new version for the changes to be available. For more details, refer to [Package Version Control](/packages/reference/versioning).

</dd>

4. Open your App from the homepage and ensure that both the app and modules share the same workspace.

Expand Down
33 changes: 1 addition & 32 deletions website/docs/packages/reference/versioning.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Version Control and Tagging
# Package Version Control

This page provides information about versioning and tagging in Packages. You can connect a Package to any Git remote repository, similar to applications. When a Package is Git-connected, you can commit changes, merge branches, and create tagged releases.

Expand All @@ -11,20 +11,6 @@ You can manage versions of a Git-connected Package using the Commit button in th

If the Package is not Git-connected, the Deploy button appears instead of Commit. Deploying applies changes immediately without version control.

<div style={{ position: "relative", paddingBottom: "calc(50.52% + 41px)", height: 0, width: "100%" }}>
<iframe
src="https://demo.arcade.software/8YXnoaVs7aymi6L8VUDb?embed"
frameBorder="0"
loading="lazy"
webkitAllowFullScreen
mozAllowFullScreen
allowFullScreen
allow="fullscreen"
style={{ position: "absolute", top: 0, left: 0, width: "100%", height: "100%" }}
title="Appsmith | Connect Data"
/>
</div>




Expand Down Expand Up @@ -79,23 +65,6 @@ Version tagging allows applications to reference a specific release instead of t

## Using Package Versions in Applications


<div style={{ position: "relative", paddingBottom: "calc(50.52% + 41px)", height: 0, width: "100%" }}>
<iframe
src="https://demo.arcade.software/uGBMPiHXi887JH4awT5i?embed"
frameBorder="0"
loading="lazy"
webkitAllowFullScreen
mozAllowFullScreen
allowFullScreen
allow="fullscreen"
style={{ position: "absolute", top: 0, left: 0, width: "100%", height: "100%" }}
title="Appsmith | Connect Data"
/>
</div>



You can select a Package version from the **Libraries** section in the **Entity Explorer** by choosing from the available options. Only Packages currently used in the application are listed. If a Package or module is not used in the application, it will not appear in the selection menu.

- **For Git-connected Packages:** You can choose from a list of available Package versions that have been released. Each version corresponds to a tagged commit, allowing you to control which version is used in your application.
Expand Down
9 changes: 8 additions & 1 deletion website/docs/packages/tutorial/js-module.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,8 +92,13 @@ export default {
</dd>


5. **Publish** the JS module from top-right corner. This allows the changes to reflect on the app side.

5. **Publish** the JS Module.
<dd>

If the package is git-connected, you also need to release a new version for the changes to be available. For more details, refer to [Package Version Control](/packages/reference/versioning).

</dd>

## Use JS module

Expand Down Expand Up @@ -145,6 +150,8 @@ With this, you can format dates using the JS module in multiple places throughou

:::info
When you update and publish a package, these modifications automatically apply in the edit mode of the app. However, the live (deployed) version of the app remains unchanged until you redeploy the app.

If the package is git-connected, it continues to use the previous version until it is changed directly while editing the app.
Copy link

Choose a reason for hiding this comment

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

Suggestion: to make it more clear that the difference of git vs. non-git is only in edit mode and that deploy mode has the same behavior no matter the git connection exists or not, what if we change the order of the text to something like:

:::info
When you update and publish a package, these modifications automatically apply in the edit mode of the app. If the package is git-connected, it continues to use the previous version until it is changed directly. 
However, in both cases, the live (deployed) version of the app remains unchanged until you redeploy the app.

:::

### See also
Expand Down
14 changes: 7 additions & 7 deletions website/docs/packages/tutorial/query-module.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,6 @@ You'll create a reusable query module using product inventory data and display t
* ♻️ **Reusability:** Discover how to reuse the query module within applications
:::

## Prerequisites
Before you start, make sure you have the following:

* A self-hosted instance of Appsmith with a [paid subscription](https://www.appsmith.com/pricing). Refer to the [Appsmith installation guides](/getting-started/setup/installation-guides) for detailed instructions on setting up your Appsmith instance.
* If you are new to Appsmith, see [Tutorial - Basics](/getting-started/tutorials/start-building).


## Create query module

Expand Down Expand Up @@ -126,7 +120,13 @@ SELECT * FROM public."product" LIMIT {{inputs.limit}} OFFSET {{inputs.offset}};
11. **Run** the query to ensure it retrieves the data correctly.


12. **Publish** the query module from top-right corner. This allows the changes to reflect on the app side.
12. **Publish** the query module from top-right corner. This allows the changes to reflect on the app side.

<dd>

If the package is git-connected, you also need to release a new version for the changes to be available. For more details, refer to [Package Version Control](/packages/reference/versioning).

</dd>



Expand Down