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

[INF] Set independent environment for building documentation #1141

Merged
merged 6 commits into from
Aug 11, 2022

Conversation

Zeroto521
Copy link
Member

@Zeroto521 Zeroto521 commented Aug 10, 2022

PR Description

Please describe the changes proposed in the pull request:

/environment-dev.yml is complex.
It's used for building doc, setting developer local env, and setting ci test env.
This file becomes big and big and hard to understand.

Part of #1133.

PR Checklist

Please ensure that you have done the following:

  1. PR in from a fork off your branch. Do not PR from <your_username>:dev, but rather from <your_username>:<feature-branch_name>.
  1. If you're not on the contributors list, add yourself to AUTHORS.md.
  1. Add a line to CHANGELOG.md under the latest version header (i.e. the one that is "on deck") describing the contribution.
    • Do use some discretion here; if there are multiple PRs that are related, keep them in a single line.

Automatic checks

There will be automatic checks run on the PR. These include:

  • Building a preview of the docs on Netlify
  • Automatically linting the code
  • Making sure the code is documented
  • Making sure that all tests are passed
  • Making sure that code coverage doesn't go down.

Relevant Reviewers

Please tag maintainers to review.

@Zeroto521 Zeroto521 changed the title INF: Set indenpend environment for building documentation [INF] Set indenpend environment for building documentation Aug 10, 2022
@@ -22,16 +22,12 @@ jobs:
with:
auto-update-conda: true
miniforge-variant: Mambaforge
channels: conda-forge
activate-environment: pyjanitor-dev
Copy link
Member Author

Choose a reason for hiding this comment

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

The value of channels and activate-environment use the variable of mkdocs/environment.yml

use-mamba: true

- name: Build docs
run: |
conda activate pyjanitor-dev
Copy link
Member Author

Choose a reason for hiding this comment

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

default will activate that env

@codecov
Copy link

codecov bot commented Aug 10, 2022

Codecov Report

Merging #1141 (933bcf8) into dev (f753323) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##              dev    #1141   +/-   ##
=======================================
  Coverage   97.34%   97.34%           
=======================================
  Files          77       77           
  Lines        3240     3240           
=======================================
  Hits         3154     3154           
  Misses         86       86           

CHANGELOG.md Outdated Show resolved Hide resolved
Copy link
Member

@ericmjl ericmjl left a comment

Choose a reason for hiding this comment

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

Only one change request, and then let's merge!

@samukweku samukweku changed the title [INF] Set indenpend environment for building documentation [INF] Set independent environment for building documentation Aug 10, 2022
Co-authored-by: Eric Ma <ericmjl@users.noreply.github.com>
@Zeroto521
Copy link
Member Author

Why this test case (tests/functions/test_conditional_join.py::test_multiple_eqs_extension_array) failed in https://github.com/pyjanitor-devs/pyjanitor/runs/7761821318?check_suite_focus=true but passed now?

@ericmjl
Copy link
Member

ericmjl commented Aug 11, 2022

Why this test case (tests/functions/test_conditional_join.py::test_multiple_eqs_extension_array) failed in https://github.com/pyjanitor-devs/pyjanitor/runs/7761821318?check_suite_focus=true but passed now?

I'm not sure, @Zeroto521 - some tests may be flaky, I guess. Usually a re-run of the CI might do the trick.

With everything green, I'm happy to merge!

@ericmjl ericmjl merged commit 6c43b9d into pyjanitor-devs:dev Aug 11, 2022
@Zeroto521 Zeroto521 deleted the ci/independ-doc-environment branch August 11, 2022 02:29
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.

None yet

2 participants