Automate SuiteCloud CLI Publishing Actions (sacc:version, sacc:upgrade, etc.)

[Extend-Apps]

Contact Email

darren@extendapps.com

Type of Contribution

Feature Request

Product

SuiteCloud CLI

Contribution Description

We propose adding automation features to the CLI for versioning and upgrading SuiteApp projects (sacc:version, sacc:upgrade, etc.).

This would enable these actions to be executed programmatically, streamlining the development lifecycle. These enhancements would support hooks for Git merges and other automation tools, ensuring a seamless deployment process.

Prerequisites

Yes

Additional Information

Feature Request Details

Problem Statement

Manually running sacc:version, sacc:upgrade, and related commands introduces inefficiencies and potential errors when publishing SuiteApp projects. Developers need an automated way to execute these commands as part of their CI/CD pipelines.

Proposed Solution

Introduce new CLI options or configuration settings that allow developers to automate publishing actions. Suggested capabilities include:

1. Automated Versioning: Allow sacc:version to accept parameters for automatic version increments (major/minor/patch) based on conventional commits or other versioning strategies.
2. Automated Upgrade Execution: Enable sacc:upgrade to be executed without manual intervention, ensuring all dependencies and configurations are correctly applied.
3. Pre/Post Hooks for Git Integration: Allow the CLI to trigger publishing actions in response to Git events (e.g., on merge to main or develop branches).
4. Configurable YAML/JSON File for CI/CD: Support defining these behaviors in a configuration file (suitecloud.config.json or .suitecloudrc), enabling teams to standardize deployment processes.

Use Cases

• Developers can integrate versioning and publishing steps into GitHub Actions, GitLab CI/CD, Jenkins, or Azure DevOps pipelines.
• Teams can enforce versioning consistency across SuiteApp deployments.
• Automated deployments reduce the risk of manual errors and improve development velocity.

Implementation Suggestions

• Extend the sacc commands with additional flags (e.g., sacc:version --auto to auto-increment).
• Provide environment variables to control CLI behavior (SACC_AUTO_VERSION=patch, SACC_AUTO_UPGRADE=true).
• Introduce a sacc:publish command that combines versioning and upgrade steps into a single automated workflow.

Additional Notes

• Ensuring authentication tokens persist across automated runs will be crucial for CI/CD use cases.
• Compatibility with existing SuiteApp project structures should be maintained.

Would love to hear thoughts from the SuiteCloud development team! 🚀

[alisyed-19]

@Extend-Apps The use case is not very clear.
Lets try to refine it a bit:
Basically what I understood is that you want the functionality is suitecloud-cli you as a dev you can directly push the SuiteApp to NetSuite Control Center?
If this is the case, can you list out the cases you would like to have automated? For example
For example:

1. Uploading the zip to control center.
2. update the version of the suiteapp
3. Check the status of suiteapp in control center

[Extend-Apps]

@alisyed-19

• sacc:mysuiteapps -list
  • returns a list of registered SuiteApps
• sacc:definition:update -appid 123 -name 'NewName'
  • updates the name of a SuiteApp
• sacc:version -appId 123 -list
  • returns a list of versions for a SuiteApp
• sacc:version:create -appId 123 -zip: Project.zip -minVer 2024.2 -phase 'leading'
  • creates a new version for a SuiteApp
• sacc:installbase -list
  • returns a list of the SuiteApps installbase

We should have to log into SuiteApp Control Center to 'Release' the version, but the above would allow CI tools to do all the heavy lifting.

[Extend-Apps]

Additional suggestions from the community are

• --token-file flag or environment variable (e.g., SACC_OAUTH_TOKEN) to pass pre-generated tokens from a CI/CD secret store (e.g., GitHub Secrets).
• sacc:auth:refresh command to renew tokens programmatically, with output compatible with CI tools (e.g., JSON: {"access_token": "xyz", "expires": "2025-03-01"}).