Skip to content

feat: support tar archives for installs #3874

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

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

feat: support tar archives for installs #3874

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
0b7c0a1
feat: support tar archives for installs
mnriem Jul 30, 2026
936e761
chore: clean rebased archive imports
mnriem Jul 30, 2026
2fb0b04
fix: preserve hardened archive install behavior
mnriem Jul 30, 2026
2ce3d05
fix: extract staged workflow archives by descriptor
mnriem Jul 30, 2026
7845508
fix: extract catalog archives from verified bytes
mnriem Jul 30, 2026
1525575
fix: address archive install review feedback
mnriem Jul 30, 2026
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
15 changes: 12 additions & 3 deletions docs/reference/workflows.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,10 +103,17 @@ specify workflow add <source>

| Option | Description |
| --------------- | ------------------------------------------------------ |
| `--dev` | Install from a local workflow YAML file or directory |
| `--dev` | Install from a local YAML file, package directory, or archive |
| `--from <url>` | Install from a custom URL (`<source>` names the expected workflow ID) |

Installs a workflow from the catalog, a URL (HTTPS required), a local YAML file, or a local directory containing `workflow.yml`.
Installs a workflow from the catalog, an HTTPS URL, a local YAML file, a
directory containing `workflow.yml`, or a `.zip`, `.tar.gz`, or `.tgz`
archive. Archives may contain `workflow.yml` at the root or inside one
top-level directory.

Directory and archive installs preserve the complete workflow package,
including scripts and other companion files. ZIP, `.tar.gz`, and `.tgz`
archives follow the same validation and installation behavior.

## Workflow Overlays

Expand Down Expand Up @@ -281,7 +288,9 @@ Lower priority values have higher precedence. Change this overlay to `priority:

### Interaction with Bundles and Updates

`specify workflow add <local-directory>` installs `workflow.yml` from the local directory into `.specify/workflows/<id>/`.
`specify workflow add <local-directory>` installs the complete local workflow
package into `.specify/workflows/<id>/`. Archive installs preserve the same
package contents.

When an installed workflow is refreshed or reinstalled, project overlays in `.specify/workflows/overlays/<id>/` are preserved because they live outside the installed workflow directory.

Expand Down
Loading