Release
Learn how to release your project using Sealos DevBox
After you've developed and tested your application, the next step is to release it as an OCI (Open Container Initiative) image. This process allows you to version your application and prepare it for deployment.
Prepare Your Application for Release
Open the Terminal in Cursor IDE
In the Cursor IDE terminal, navigate to your project directory if you're not already there.
Prepare Your Application (if necessary)
Depending on your project's language or framework, you may need to prepare your application for release. This step varies widely between different technologies:
- For compiled languages (e.g., Java, Go):
Run your build command (e.g.,
mvn package
,go build
) - For interpreted languages with build steps (e.g., TypeScript, some JavaScript frameworks):
Run your build or transpilation command (e.g.,
npm run build
,tsc
) - For interpreted languages without build steps (e.g., Python, Ruby):
Ensure all dependencies are listed in your requirements file (e.g.,
requirements.txt
,Gemfile
)
If your project doesn't require any preparation, you can skip this step.
Review and Update entrypoint.sh
Each Devbox project has an entrypoint.sh
file that contains the startup command for your OCI image. It's crucial to review and, if necessary, update this file:
- Open the
entrypoint.sh
file in your project directory. - Review the startup command. It should correctly start your application.
- If needed, modify the command to match your application's requirements.
For example, a Java application might have:
While a Python application might have:
Ensure this file is executable by running:
The entrypoint.sh
file is crucial for your application's startup in the OCI image. Make sure it correctly launches your application before proceeding with the release.
Release as OCI Image
Access Project Details
- Go to the Sealos Devbox List in your browser.
- Find your project and click on the "Detail" button on the right side of your project's row.
Initiate Release Process
On the project details page:
- Look for the "Version" section.
- Click on the "Release" button located in the top right corner of the "Version" section.
Configure Release Details
In the "Release" dialog box that appears, provide the following information:
- Image Name: This field is pre-filled with your project's image name.
- Tag: Enter a version tag for your release (e.g., v1.0).
- Description: Provide a brief description of this release (e.g., "Initial release" or "Feature update: user authentication").
Complete the Release
After filling in the required information, click the "Release" button at the bottom of the dialog box.
Verify the Release
Once the release process is complete, you'll see a new entry in the "Version" section of your project details page. This entry will show:
- The tag you assigned
- The status of the release
- The creation time
- The description you provided
Best Practices for Releasing
-
Semantic Versioning: Consider using semantic versioning (e.g., v1.0.0) for your tags. This helps in tracking major, minor, and patch releases.
-
Descriptive Releases: Provide clear and concise descriptions for each release. This helps team members understand what changes or features are included in each version.
-
Regular Releases: Create new releases whenever you make significant changes or reach important milestones in your project. This practice helps in maintaining a clear history of your application's development.
-
Pre-release Testing: Always thoroughly test your application before creating a release. This ensures that the released version is stable and ready for deployment.
-
Consistent Build Process: Ensure your build process is consistent and reproducible. Consider using build scripts or Makefiles to standardize the build process across your team.
Next Steps
After successfully releasing your application as an OCI image, you're ready to move on to the deployment phase. The OCI image you've created can be used for deployment or shared with other team members.
Check out the "Deploy" guide for information on how to deploy your released application to a production environment.