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

Change workflows to mamba, take 2 #438

Merged
merged 5 commits into from
Jun 16, 2023

Conversation

xylar
Copy link
Contributor

@xylar xylar commented Jun 16, 2023

This merge attempts to move all workflows (including building the documentation) to mamba instead of pip.

@@ -26,10 +26,9 @@ dependencies:
# If versions are updated, also update in `.github/workflows/build_workflow.yml`
# =================
- sphinx=5.2.3
- sphinx-multiversion=0.2.4
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this matters but using single rather than double = here to match other dependencies.

Comment on lines -70 to -71
# IMPORTANT: This needs to be set for caching to work properly!
use-only-tar-bz2: true
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this is necessary any longer.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And I think it causes problems because most newer releases are as .conda files.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This may explain why sphinx-multiversion couldn't be installed.

Comment on lines -117 to -118
# Using pip for Sphinx dependencies because it takes too long to reproduce a conda environment (~10 secs vs. 3-4 mins)
- name: Install Dependencies
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be much better with mamba instead of conda.

@xylar
Copy link
Contributor Author

xylar commented Jun 16, 2023

@forsyth2 and @tomvothecoder, I think the problem with #429 and #434 were that you did not actually switch to creating a mambaforge environment for building the docs. The environment was still being created with pip and therefore mamba was not installed. An additional problem was the use-only-tar-bz2: true when you were creating the conda environment for testing. This prevents newer packages like sphinx-multiversion from being installed and I have found that caching works even without this line.

@xylar
Copy link
Contributor Author

xylar commented Jun 16, 2023

Unfortunately, we do not have a good way of testing these workflows until we merge this branch and make an rc2 tag.

Copy link
Collaborator

@forsyth2 forsyth2 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @xylar! This looks good from what I can tell. Should I merge it?

@xylar
Copy link
Contributor Author

xylar commented Jun 16, 2023

@forsyth2, I think so but I really can't be sure until we actually try a merge and see how it goes.

@forsyth2 forsyth2 merged commit 184668c into E3SM-Project:main Jun 16, 2023
@xylar xylar deleted the change-workflow-to-mamba-take2 branch June 17, 2023 12:19
@xylar
Copy link
Contributor Author

xylar commented Jun 17, 2023

@forsyth2, it seems like things worked fine so let's proceed with zstash.

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