Skip to content
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.

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

Check how versioning works for xplatform api docs #1043

Closed
dkamburov opened this issue Oct 20, 2023 · 2 comments
Closed

Check how versioning works for xplatform api docs #1043

dkamburov opened this issue Oct 20, 2023 · 2 comments
Assignees

Comments

@dkamburov
Copy link
Contributor

No description provided.

@MayaKirova
Copy link
Contributor

MayaKirova commented Oct 20, 2023

How it works for Angular Api docs:

  1. The release build that runs for angular-docs: https://infragistics.visualstudio.com/NetAdvantage/_build?definitionId=16

This triggers Octopus deploy.

  1. That triggers a post deploy script: https://github.com/IgniteUI/igniteui-angular/blob/master/angularDocsPostDeploy.ps1

This creates folders and updates the angular-api-docs-versions.json with all api docs versions on the staging/release machines.

  1. The drop down uses this code: https://github.com/IgniteUI/ig-typedoc-theme/blob/master/src/assets/js/src/versioning/tag-versions.req.js

Which basically makes request to the json file which holds all versions.

There’s also a config file with all urls for dev/staging/prod:
https://github.com/IgniteUI/ig-typedoc-theme/blob/master/config.json

Note: The ig-typedoc-theme will need some mechanism to configure react/wc endpoints and not have any hardcoded angular urls (like the one here: https://github.com/IgniteUI/ig-typedoc-theme/blob/master/src/assets/js/src/versioning/tag-versions.req.js) if we want it to be reusable for wc/react.

@MayaKirova
Copy link
Contributor

Idea for similar workflow for react/wc (in short):

  1. Add a new Stage to the exiting React/WC Release pipeline that will:
  • Retrieve the typedoc zip.
  • Deploy to a versioned directory to the staging/prod machines via a Powershell script. Also create/update the related "*versions.json" with the version info. Also update "latest" if needed.
  1. Remove the specific WC/React ApiDocs release pipe(https://infragistics.visualstudio.com/NetAdvantage/_release?_a=releases&view=mine&definitionId=42) as it will now be obsolete.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants