Repository navigation
ci(sassdoc): add release workflow that deploys the SassDoc - #17891
Merged
Merged
Conversation
Builds the SassDoc for the newest release and dispatches its deploy to IgniteUI/igniteui-actions, replacing the AZDO angular-docs-en pipeline. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This was referenced Oct 29, 2026
Every release goes to angular-docs/<version>/sass, one folder per minor line, and the newest one also to sass/latest, as the AZDO pipeline did. Staging takes every release, production stable ones only. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2 of 23 tasks
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Adds
.github/workflows/sass-docs-deploy.yml. When a release is published, it builds the SassDoc site and hands it toIgniteUI/igniteui-actions, which deploys it underangular-docson the internal web servers. This replaces the SassDoc part of theangular-docs-enAzure DevOps pipeline. The API docs part already moved toIgniteUI/api-docs.Each release lands where the AZDO pipeline put it:
angular-docs/<version>/sass: one folder per minor line, holding its newest release. It is served at/products/ignite-ui-angular/docs/<version>/sass/and listed in the version selector.angular-docs/sass/latest: the newest release. It is served at/products/ignite-ui-angular/docs/sass/latest/.Staging gets every release; production gets stable releases only.
The jobs:
latestis set only while it is also the newest overall: newest tag for staging, newest stable tag for production. This is the AZDO pipeline'sisLatest/isLatestProdrule.npm ciandnpm run build:sassdoc:en:<env>at the release tag. It then stages<version>/sass, addingnoindex,nofollowto everyindex.htmlas the AZDO pipeline did, andsass/latestwhen applicable. The result is uploaded assass-docs-<env>-<version>.igniteui-actionsand sendsigniteui-angular-sass-docs-cdwithenvironment,versionandlatest. igniteui-actions then mirrors the folders, removes the other folders of that minor line, and rebuilds the version selector's list (angular-api-docs-versions(-prod).json).workflow_dispatchwith arelease_taginput re-runs the deploy for a tag.Motivation / Context
Requires IgniteUI/igniteui-actions#74, which adds the workflow that receives the dispatch.
Release events run the workflow file from the tagged commit, so this is backported to every active line: 22.2.x #17892, 22.1.x #17893, 22.0.x #17894.
After a release deploys through this, the AZDO pipeline can be disabled and
angularDocs.nuspec/angularDocsPostDeploy.ps1removed.Type of Change (check all that apply):
Component(s) / Area(s) Affected:
CI, SassDoc
How Has This Been Tested?
Unit tests
Manual testing
Automated e2e tests
actionlintpasses on the workflow.I ran the resolve step's script unchanged in
ubuntu:24.04against the repository's 1355 tags:I ran the staging step against a sample build:
noindexis added to everyindex.htmlin the version folder only,web.configis kept, andsass/latestis added only for the newest release.Not yet run end to end. That needs igniteui-actions#74 merged, then a release or a
workflow_dispatchrun.Test Configuration:
Checklist:
feature/README.MDupdates for the feature docsREADME.MDCHANGELOG.MDupdates for newly added functionalityng updatemigrations for the breaking changes (migrations guidelines)🤖 Generated with Claude Code