-
Notifications
You must be signed in to change notification settings - Fork 65
Add versioned documentation support for releases #708
Copy link
Copy link
Open
Labels
area: compatibilityCompatibility, availability, legacy support, and cross-version behavior.Compatibility, availability, legacy support, and cross-version behavior.area: docsDocumentation area label.Documentation area label.area: toolingDeveloper tooling, package manifests, Tuist, scripts, formatting, or release tooling.Developer tooling, package manifests, Tuist, scripts, formatting, or release tooling.type: docsDocumentation, README, guides, or package index metadata.Documentation, README, guides, or package index metadata.type: featureNew API, behavior, platform support, or user-facing capability.New API, behavior, platform support, or user-facing capability.
Metadata
Metadata
Assignees
Labels
area: compatibilityCompatibility, availability, legacy support, and cross-version behavior.Compatibility, availability, legacy support, and cross-version behavior.area: docsDocumentation area label.Documentation area label.area: toolingDeveloper tooling, package manifests, Tuist, scripts, formatting, or release tooling.Developer tooling, package manifests, Tuist, scripts, formatting, or release tooling.type: docsDocumentation, README, guides, or package index metadata.Documentation, README, guides, or package index metadata.type: featureNew API, behavior, platform support, or user-facing capability.New API, behavior, platform support, or user-facing capability.
Type
Fields
Give feedbackNo fields configured for issues without a type.
Description
Currently, the documentation deployment script (
update-gh-pages-documentation.sh) publishes documentation without version tracking. After each release, we should be able to generate and maintain documentation for specific versions.Proposed Solution
Add a
--versionparameter to the documentation update script that:0.1.0,1.0.0)Suggested Implementation
Script Changes
--version VERSIONparameter toScripts/update-gh-pages-documentation.shgh-pages/docs/{version}/latestsymlink or redirect to the most recent versionWorkflow
After each tag release, GitHub workflow should automatically run the following command
Directory Structure
Benefits