Skip to content

docs-ci: Add pip install option#28

Merged
victorlin merged 2 commits intomasterfrom
victorlin/docs-ci/add-pip-install
Dec 6, 2022
Merged

docs-ci: Add pip install option#28
victorlin merged 2 commits intomasterfrom
victorlin/docs-ci/add-pip-install

Conversation

@victorlin
Copy link
Copy Markdown
Member

@victorlin victorlin commented Nov 8, 2022

Description of proposed changes

Some docs projects use pip instead of conda to set up the environment.

  1. Make environment-file input (Conda setup) optional.

  2. Add a new optional input to install from pip.

  3. Use one job per environment setup option.

Specifying none of the setup options will cause both jobs to be skipped, but I think that's appropriate user error.

Related issue(s)

Testing

Copy link
Copy Markdown
Contributor

@tsibley tsibley left a comment

Choose a reason for hiding this comment

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

Yay, glad to see this. My idea had been to make this workflow read the RTD config file and install what's configured there, which I still think would be nicer, but it's more complex.

Comment thread .github/workflows/docs-ci.yaml
@victorlin victorlin force-pushed the victorlin/docs-ci/add-pip-install branch from fa0bf2b to f1a8182 Compare December 5, 2022 23:24
Some docs projects use pip instead of conda to set up the environment.

1. Make environment-file input (Conda setup) optional.

2. Add a new optional input to install from pip.

3. Use one job per environment setup option.

Specifying none of the setup options will cause both jobs to be skipped,
but I think that's appropriate user error.
@victorlin victorlin force-pushed the victorlin/docs-ci/add-pip-install branch from f1a8182 to 79386fb Compare December 5, 2022 23:33
@victorlin victorlin requested a review from tsibley December 5, 2022 23:48
Copy link
Copy Markdown
Contributor

@tsibley tsibley left a comment

Choose a reason for hiding this comment

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

🙌

@victorlin victorlin merged commit 63252d3 into master Dec 6, 2022
@victorlin victorlin deleted the victorlin/docs-ci/add-pip-install branch December 6, 2022 22:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

No open projects

Development

Successfully merging this pull request may close these issues.

docs-ci: Make the Conda setup optional

2 participants