Skip to content

Deploy docs to a new folder named after their tagged version#372

Merged
jcapriot merged 14 commits intomainfrom
deploy-docs-versions
Sep 6, 2024
Merged

Deploy docs to a new folder named after their tagged version#372
jcapriot merged 14 commits intomainfrom
deploy-docs-versions

Conversation

@santisoler
Copy link
Member

@santisoler santisoler commented Sep 3, 2024

  • Make deployment stage to depend on DocBuild
  • Store discretize version in a variable
  • Update latest symlink

TODO:

  • Replace the latest folder by a symlink in simpeg/discretize-docs repo before merging this PR.
  • Remove the "experimental" stage I created to check if the version variable can be read in another stage.

Store discretize version in an Azure variable after building the docs.
Check if the version variable can be retrieved.
@codecov
Copy link

codecov bot commented Sep 3, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.25%. Comparing base (707e31f) to head (5847785).
Report is 15 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #372   +/-   ##
=======================================
  Coverage   86.25%   86.25%           
=======================================
  Files          89       89           
  Lines       18695    18695           
  Branches     2959     2959           
=======================================
  Hits        16125    16125           
  Misses       1884     1884           
  Partials      686      686           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@santisoler santisoler changed the title Deploy version of the docs to its own folder Deploy docs to a new folder named after their tagged version Sep 3, 2024
@jcapriot
Copy link
Member

jcapriot commented Sep 5, 2024

Ok, this should work now. I put in three base pipeline level variables that all stages have access to.

  • BRANCH_NAME
  • IS_TAG
  • IS_MAIN
    It creates a folder based on BRANCH_NAME, which is main for main, and the name of the tag for release versions (e.g. v0.10.0), and avoids the awkward python call to the installed discretize version.

@jcapriot jcapriot marked this pull request as ready for review September 6, 2024 20:59
@jcapriot
Copy link
Member

jcapriot commented Sep 6, 2024

Let's merge and see what breaks!

@jcapriot jcapriot merged commit dba27d8 into main Sep 6, 2024
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

Successfully merging this pull request may close these issues.

2 participants