diff --git a/netlify.toml b/netlify.toml index e5193a26b..4095309d7 100644 --- a/netlify.toml +++ b/netlify.toml @@ -9,16 +9,18 @@ # Limit SSG worker threads to prevent OOM errors in Netlify builds # Docusaurus defaults to 32 threads with 1GB memory each, but Netlify's # memory limits aren't properly enforced, causing out-of-memory 137 errors. - # Limiting thread processing avoids this issue with some build time impact however, + # Limiting thread processing avoids this issue with some build time impact however, # build are still significantly faster than without SSG in-use. # Reference: https://github.com/facebook/docusaurus/discussions/11199 DOCUSAURUS_SSG_WORKER_THREAD_COUNT = "1" [context.deploy-preview.build.environment] INCLUDE_NEXT="true" + EXCLUDE_PLATFORM_API="true" + EXCLUDE_PLATFORM_OPENAPI="true" # Seqera API docs are too large to host / build on netlify on their own. -# The appropriate ENVVAR is set to disable the API Builds on Netlify for the main docs site. +# The appropriate ENVVAR is set to disable the API Builds on Netlify for the main docs site. [[redirects]] from = "/platform-api/*" to = "https://seqera-docs-api.netlify.app/platform-api/:splat" diff --git a/platform-cloud/cloud-sidebar.json b/platform-cloud/cloud-sidebar.json index 018dcaaca..74a6d1b0c 100644 --- a/platform-cloud/cloud-sidebar.json +++ b/platform-cloud/cloud-sidebar.json @@ -107,6 +107,7 @@ "items": [ "pipelines/overview", "pipeline-schema/overview", + "pipelines/versioning", "pipelines/revision", "launch/launchpad", "labels/overview", diff --git a/platform-cloud/docs/pipelines/versioning.md b/platform-cloud/docs/pipelines/versioning.md index 70a4b096d..3714b33f5 100644 --- a/platform-cloud/docs/pipelines/versioning.md +++ b/platform-cloud/docs/pipelines/versioning.md @@ -1,12 +1,12 @@ --- -title: "Pipeline versioning" +title: "Pipeline versioning (preview)" description: "Introduction to pipeline versioning in Seqera Platform." date created: "2025-11-14" tags: [pipelines, versioning, nextflow, parameters] --- -:::info -Pipeline versioning is a preview feature in active development. [Contact Seqera support](https://support.seqera.io/) to enable this feature in your organization workspaces. +:::info +Pipeline versioning is a preview feature. [Contact Seqera support](https://support.seqera.io/) to enable this feature in your organization workspaces. ::: Seqera's pipeline versioning system captures configuration changes as new draft versions of the pipeline, ensuring configuration traceability and execution reproducibility. Users with appropriate permissions can edit and publish draft versions, creating published versions that teams can reference and launch consistently. @@ -23,6 +23,19 @@ New draft versions are automatically generated when you modify the following: "track_changes": false } ``` + + For nested parameters, `track_changes` is supported at the leaf node level: + ```json + "nestedParam": { + "type": "object", + "properties": { + "leafParam": { + "type": "string", + "track_changes": false + } + } + } + ``` ::: - Fields in the pipeline **Edit** form, excluding: - **Name** @@ -32,7 +45,7 @@ New draft versions are automatically generated when you modify the following: Published versions provide a stable reference for team-wide pipeline launches. Users with Maintain or higher permissions can publish a draft version, giving it a name and optionally setting it as the default version. This makes important configurations easy to identify, share, and promote across your team. -:::info +:::info A pipeline's default version is shown in the Launchpad and automatically selected during launch. ::: @@ -44,11 +57,14 @@ Seqera maintains a history of all draft and published versions, providing an aud Select a pipeline from the workspace Launchpad to open the pipeline's details page. From here, users with Maintain or higher permissions can: -- **View version history**: See a chronological list of all draft and published versions with creator, date, and checksum. +- **View version history**: See a chronological list of all draft and published versions with creator, date, and hash. - Use the dropdown next to **Show:** to show all versions, or filter by draft or published versions. - - **Search** for specific version names (freetext search), or use keywords to search by `pipelineVersionId:` or `pipelineVersionHash:` ([version checksum](#version-checksums)). -- **Manage draft versions**: - - Select **Publish** from the options menu of a draft version to name this version and optionally make it the default version to launch from the Launchpad. + - **Search** for specific version names (freetext search), or use keywords to search by `versionId:`, `versionName:`, or `versionHash:` ([version hash](#version-hash)). +- **Manage draft versions**: + - Select **Publish** from the options menu of a draft version to name this version and optionally make it the default version to launch from the Launchpad. + :::note + Draft versions created from workflow runs can only be published from the pipeline's original workspace. For shared pipelines, the **Publish** action is only available in the workspace where the pipeline was created. + ::: - Select **Edit** to open the pipeline edit form and either save a new draft or publish the current draft version. - **Manage published versions**: - Select **Make default** from the options menu of a published version to use this version for every pipeline launch. @@ -58,12 +74,22 @@ Select a pipeline from the workspace Launchpad to open the pipeline's details pa Individual draft versions cannot be deleted - the pipeline configuration audit trail is immutable. However, published versions can be unpublished or have their names reassigned to different draft versions. :::note -A shared pipeline's versions can only be edited from its original workspace. +A shared pipeline's versions can only be edited and published from its original workspace. Draft versions created from shared pipeline runs in other workspaces cannot be published. ::: -#### Version checksums +#### Pipeline optimization + +[Pipeline optimization](../pipeline-optimization/overview) is available directly from the pipeline details page for the default version. Users with Maintain or higher permissions can: + +- **Optimize pipeline**: Configure pipeline optimization settings for the default version from the **Default** section or the **Edit pipeline** form. +- **Toggle optimization**: Enable or disable optimization for a pipeline that has already been optimized. +- **Customize profile**: Modify the optimization profile settings when optimization is enabled. + +Pipeline optimization settings apply to the default version and remain configured when you set a different version as the default. + +#### Version hash -Seqera calculates a checksum for each draft version based on its version-triggering parameters. This provides: +Seqera calculates a hash for each draft version based on its version-triggering parameters. This provides: - **Cryptographic verification** that a workflow run's configuration matches its associated pipeline version -- **Provenance tracking** for audit and compliance requirements \ No newline at end of file +- **Provenance tracking** for audit and compliance requirements diff --git a/platform-enterprise_versioned_docs/version-25.3/pipelines/versioning.md b/platform-enterprise_versioned_docs/version-25.3/pipelines/versioning.md index c7edff38c..cde20b7c1 100644 --- a/platform-enterprise_versioned_docs/version-25.3/pipelines/versioning.md +++ b/platform-enterprise_versioned_docs/version-25.3/pipelines/versioning.md @@ -5,8 +5,8 @@ date created: "2025-11-14" tags: [pipelines, versioning, nextflow, parameters] --- -:::info -Pipeline versioning is a preview feature in active development. See [Core features](../enterprise/configuration/overview.mdx#core-features) for instructions to enable this feature in your organization workspaces. +:::info +Pipeline versioning is a preview feature in active development. See [Core features](../enterprise/configuration/overview.mdx#core-features) for instructions to enable this feature in your organization workspaces. ::: Seqera's pipeline versioning system captures configuration changes as new draft versions of the pipeline, ensuring configuration traceability and execution reproducibility. Users with [Maintain or higher](../orgs-and-teams/roles.md) permissions can edit and publish draft versions, creating published versions that teams can reference and launch consistently. @@ -24,6 +24,19 @@ New draft versions are automatically generated during pipeline edit or launch wh "track_changes": false } ``` + + For nested parameters, `track_changes` is supported at the leaf node level: + ```json + "nestedParam": { + "type": "object", + "properties": { + "leafParam": { + "type": "string", + "track_changes": false + } + } + } + ``` ::: - Fields in the pipeline **Edit** form, excluding: - **Name** @@ -45,11 +58,14 @@ Seqera maintains a history of all draft and published versions, providing an aud Select a pipeline from the workspace Launchpad to open the pipeline's details page. From here, users with Maintain or higher permissions can: -- **View version history**: See a chronological list of all draft and published versions with creator, date, and checksum. +- **View version history**: See a chronological list of all draft and published versions with creator, date, and hash. - Use the dropdown next to **Show:** to show all versions, or filter by draft or published versions. - - **Search** for specific version names (freetext search), or use keywords to search by `pipelineVersionId:` ([version checksum](#version-checksums)). + - **Search** for specific version names (freetext search), or use keywords to search by `versionId:`, `versionName:`, or `versionHash:` ([version hash](#version-hash)). - **Manage draft versions**: - Select **Publish** from the options menu of a draft version to name this version and optionally make it the default version to launch from the Launchpad. + :::note + Draft versions created from workflow runs can only be published from the pipeline's original workspace. For shared pipelines, the **Publish** action is only available in the workspace where the pipeline was created. + ::: - Select **Edit** to open the pipeline edit form and either save a new draft or publish the current draft version. - **Manage published versions**: - Select **Make default** from the options menu of a published version to use this version for every pipeline launch. @@ -59,12 +75,22 @@ Select a pipeline from the workspace Launchpad to open the pipeline's details pa Individual versions cannot be deleted. This ensures that the pipeline configuration audit trail is immutable. However, published versions can be unpublished or have their names reassigned to different versions. :::note -A shared pipeline's versions can only be edited from its original workspace. +A shared pipeline's versions can only be edited and published from its original workspace. Draft versions created from shared pipeline runs in other workspaces cannot be published. ::: -#### Version checksums +#### Pipeline optimization + +[Pipeline optimization](../pipeline-optimization/overview) is available directly from the pipeline details page for the default version. Users with [Maintain or higher](../orgs-and-teams/roles.md) permissions can: + +- **Optimize pipeline**: Configure pipeline optimization settings for the default version from the **Default** section or the **Edit pipeline** form. +- **Toggle optimization**: Enable or disable optimization for a pipeline that has already been optimized. +- **Customize profile**: Modify the optimization profile settings when optimization is enabled. + +Pipeline optimization settings apply to the default version and remain configured when you set a different version as the default. + +#### Version hash -Seqera calculates a checksum for each draft version based on its version-triggering parameters. This provides: +Seqera calculates a hash for each draft version based on its version-triggering parameters. This provides: - **Provenance tracking** for audit and compliance requirements. - **Cryptographic verification** that a workflow run's configuration matches its associated pipeline version.