Reorganizing by Feature sections
Capabilities folders to give an overview of each feature
How-Tos folders to give guidance for advanced customizations
Reorganized the Developers section as well, moving the API sub section
there
added some new visuals and videos to illustrate the How-Tos articles
checked the typos, the links and added a section at the end of the
doc.json file to redirect existing links to the new ones (SEO purpose +
continuity of the user experience)
What I have not updated is the "l" folder that, per my understanding,
contains the translation of the User Guide - that I only edited in
English
<!-- CURSOR_SUMMARY -->
---
> [!NOTE]
> <sup>[Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) is
generating a summary for commit
5301502a32. Configure
[here](https://cursor.com/dashboard?tab=bugbot).</sup>
<!-- /CURSOR_SUMMARY -->
---------
Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>
Co-authored-by: github-actions <[email protected]>
Co-authored-by: Abdul Rahman <[email protected]>
Co-authored-by: Félix Malfait <[email protected]>
78 lines
2.2 KiB
Plaintext
78 lines
2.2 KiB
Plaintext
---
|
|
title: Workflow Versions
|
|
description: Manage workflow versions and drafts.
|
|
image: /images/user-guide/workflows/workflow.png
|
|
---
|
|
|
|
## About Versions
|
|
|
|
Every time you activate a workflow, a new version is created. This allows you to track changes over time and revert to previous configurations if needed.
|
|
|
|
## Version Statuses
|
|
|
|
| Status | Description |
|
|
|--------|-------------|
|
|
| **Draft** | Being edited, not yet published |
|
|
| **Active** | Live version responding to triggers |
|
|
| **Deactivated** | Previously active but manually stopped |
|
|
| **Archived** | Past versions kept for history |
|
|
|
|
## Working with Drafts
|
|
|
|
When you edit an active workflow, your changes are saved as a **draft**. The active version continues to run while you work on updates.
|
|
|
|
Once you're done editing, you can:
|
|
- **Activate**: Publish the draft as the new active version (the previous version is archived)
|
|
- **Discard**: Delete the draft and keep the current active version
|
|
|
|
## Version History
|
|
|
|
### Viewing Past Versions
|
|
1. Open the workflow
|
|
2. Click the **Versions** tab
|
|
3. See all previous versions with timestamps
|
|
|
|
### Restoring a Version
|
|
1. Find the version you want to restore
|
|
2. Click **Use as draft**
|
|
3. The version is copied to a new draft
|
|
4. Make any necessary updates
|
|
5. Activate when ready
|
|
|
|
## Best Practices
|
|
|
|
### Version Management
|
|
- Activate only when ready for production
|
|
- Keep meaningful changes between versions
|
|
- Document major changes in workflow names or descriptions
|
|
- Test in draft mode before activating
|
|
|
|
### Reverting Changes
|
|
- If a new version causes issues, restore the previous version
|
|
- Use the version history to track what changed
|
|
- Always test restored versions before activating
|
|
|
|
## Common Workflows
|
|
|
|
### Quick Edit
|
|
1. Make minor changes to an active workflow
|
|
2. Test in draft mode
|
|
3. Activate the new version
|
|
|
|
### Major Revision
|
|
1. Use the previous version as a starting point
|
|
2. Make significant changes in draft
|
|
3. Thoroughly test all scenarios
|
|
4. Activate when confident
|
|
|
|
### Rollback
|
|
1. Identify the issue with the current version
|
|
2. Find the last working version in history
|
|
3. Click **Use as draft**
|
|
4. Activate to restore the old behavior
|
|
|
|
## Related
|
|
|
|
- [Getting Started with Workflows](/user-guide/workflows/overview)
|
|
- [Workflow Runs](/user-guide/workflows/capabilities/workflow-runs)
|