Only testing doc when only doc is modified by mehtamohit013 · Pull Request #49 · ploomber/pkgmt

mehtamohit013 · 2023-05-26T18:56:31Z

Closes #47

TO DO:

implement python -m pkgmt ensure_modified
add unit tests
implement sample github workflow (you can test in the dummy repository, ask @edublancas for edit access)
open PR with the finished workflow to this repo https://github.com/ploomber/contributing

mehtamohit013 · 2023-05-26T19:08:25Z

Hey @edublancas ,
please take a look at the modified.py and please check if it satisfies all the requirements.

I have also added some test that works fine locally, but not with GitHub actions. Seems like I have to use tmp_packages in conftest.py. Any suggestion?

Sample commands:
Context: the current branch has 3 diff: folder doc, another_doc and file a.txt

pkgmt ensure-modified -b main -ex doc -ex another_doc -ex a.txt
Output: 0
pkgmt ensure-modified -b main -ex another_doc -ex a.txt
Output: 1

mehtamohit013 · 2023-05-30T16:06:15Z

@edublancas

open PR with the finished workflow to this repo https://github.com/ploomber/contributing

Also, can you please elaborate more on what you want to add to contributing guidelines?

mehtamohit013 · 2023-05-31T17:15:00Z

@edublancas

I have written a template based on the above logic here

Testing:
For testing the logic, I made pkgmt_modi branch with a new GitHub workflow. After that, I made three branches with the following commits on top of pkgmt_modi branch:

pkgmt_modi1:
File Changed: Modified doc/a.txt
Branch Compared: origin/pkgmt_modi
Output: GitHub Actions
pkgmt_modi2:
File Changed: Modified a.txt
Branch Compared: origin/pkgmt_modi
Output: GitHub Actions
pkgmt_modi3:
File Changed: Modified a.txt, doc/a.txt
Branch Compared: origin/pkgmt_modi
Output: GitHub Actions

TLDR: Tests are working as intended

edublancas

Update: nevermind. I realized the branch was hardcoded

am I testing this wrong?

I copied your workflow: https://github.com/ploomber/dummy/blob/main/.github/workflows/doc.yml

added a new file under doc/ ploomber/dummy@32a4fa3

but the output still says: executing all tests

edublancas · 2023-06-01T01:54:53Z

+    subprocess.run(["git", "commit", "-m", "init-commit-message"])
+
+    subprocess.run(["git", "checkout", "-b", "test_modified_doc"])
+    subprocess.run(["mkdir", "-p", "test_doc1"])


convert mkdir and touch calls to pathlib.Path since the latter are OS independent

I have converted all the calls to pathlib.Path, but Windows tests are still failing. For more info, please check the tests here

Update: Found the error, working on it

yeah, some stuff isn't compatible with windows, so no need to add windows and macos to the testing configuration. I suggested changing it to pathlib because at some point we might want to support those OS as well

I tried but it is not working on Windows

I think it maybe because of not using ' ' in exclude path like ':^doc' instead of :^doc (due to this error), I will try this approach tomorrow

Nope not working
Github Actions

Some links:
Link1
Link2

edublancas · 2023-06-01T01:56:38Z

@@ -0,0 +1,47 @@
+import subprocess


also create a github workflow with the full logic

it should run the modified command, and if only doc has been modified. it should skip all upcoming steps

Template

One can use if: steps.check_doc.outcome == 'failure' to determine whether only doc has been modified or not

mehtamohit013 · 2023-06-02T17:13:01Z

@edublancas
Template

With sys.exit
Testing:

pkgmt_modi1:
File Changed: Modified doc/a.txt
Branch Compared: origin/pkgmt_modi
Output: GitHub Actions
pkgmt_modi2:
File Changed: Modified a.txt
Branch Compared: origin/pkgmt_modi
Output: GitHub Actions
pkgmt_modi3:
File Changed: Modified a.txt, doc/a.txt
Branch Compared: origin/pkgmt_modi
Output: GitHub Actions

TLDR: Tests are working as intended

See updated links below

mehtamohit013 · 2023-06-05T13:22:51Z

@edublancas

Template

With windows testing and sys.exit
Testing:

pkgmt_modi1:
File Changed: Modified doc/a.txt
Branch Compared: origin/pkgmt_modi
Output: GitHub Actions
pkgmt_modi2:
File Changed: Modified a.txt
Branch Compared: origin/pkgmt_modi
Output: GitHub Actions
pkgmt_modi3:
File Changed: Modified a.txt, doc/a.txt
Branch Compared: origin/pkgmt_modi
Output: GitHub Actions

TLDR: Tests are working as intended on ubuntu and macos. Not working for windows

edublancas · 2023-06-05T21:18:16Z

@mehtamohit013: just to confirm what we discussed earlier today. since windows support is giving too much trouble, let's not worry about it for now

mehtamohit013 · 2023-06-05T21:22:35Z

@mehtamohit013: just to confirm what we discussed earlier today. since windows support is giving too much trouble, let's not worry about it for now

@edublancas
Ok, then, I believe I have resolved all the issues and the PR is ready to be reviewed and merge

mehtamohit013 added 4 commits May 26, 2023 14:25

Added git diff

927d6a3

test modified

43758d8

Fix

f9977da

Format

3a8f70a

mehtamohit013 changed the title ~~Only testing doc when only doc is modified~~ Only testing doc when only doc is modified - WIP May 26, 2023

edublancas requested changes May 30, 2023

View reviewed changes

Comment thread src/pkgmt/cli.py Outdated

Comment thread src/pkgmt/cli.py Outdated

Comment thread src/pkgmt/cli.py Outdated

mehtamohit013 added 5 commits May 30, 2023 10:37

Changed API

8f0a825

Fix

ce8a4f9

tmp package

8e8e409

Fix tests

18a1814

Fix test

242cf1a

mehtamohit013 marked this pull request as ready for review May 30, 2023 15:44

mehtamohit013 requested a review from edublancas May 30, 2023 15:45

mehtamohit013 changed the title ~~Only testing doc when only doc is modified - WIP~~ Only testing doc when only doc is modified May 30, 2023

edublancas requested changes May 30, 2023

View reviewed changes

Comment thread src/pkgmt/modified.py

Comment thread src/pkgmt/modified.py Outdated

Comment thread src/pkgmt/modified.py Outdated

mehtamohit013 added 4 commits May 31, 2023 10:45

Changed args

92533de

Added sys exit

f4de4d4

Revert sys.exit

c928988

Lint

99dc484

mehtamohit013 requested a review from edublancas May 31, 2023 17:20

edublancas requested changes Jun 1, 2023

View reviewed changes

Comment thread src/pkgmt/modified.py

mehtamohit013 added 4 commits June 1, 2023 11:58

Added test case

8f880a8

Renaming

b2667bb

Added Pathlib implementation

8c09d1b

tmp deleted workdlow tag check

34853e5

mehtamohit013 added 12 commits June 1, 2023 12:21

Fix CI

631c27c

Commented Tests

f867bb1

Format

ce3ee64

Commented some more

539c7eb

more comments

0fdbc34

Fix conftest

9be7f6d

Format

86989b9

Fix conftest

c03a61a

Format

5486626

Verbose testing

4a056eb

Revert back CI changes

51e382f

Moved to sys.exit

c7e2d47

mehtamohit013 and others added 3 commits June 2, 2023 13:13

Minor

8cfd99a

Minor

a5998cc

Merge branch 'doc' of github.com:mehtamohit013/pkgmt into doc

7c264f7

mehtamohit013 requested a review from edublancas June 2, 2023 17:15

mehtamohit013 added 5 commits June 2, 2023 13:18

Minor

fe85854

Format

83ced20

Fix

20c65e0

Windows CI

b7f0147

Revert back Windows CI

988f1d3

edublancas approved these changes Jun 6, 2023

View reviewed changes

edublancas merged commit af715cb into ploomber:main Jun 6, 2023

mehtamohit013 mentioned this pull request Jun 6, 2023

modify CI to skip tests if only doc has been modified ploomber/jupysql#575

Closed

mehtamohit013 mentioned this pull request Jun 26, 2023

Fixed CI (Doc checking) ploomber/jupysql#668

Merged

4 tasks

mehtamohit013 deleted the doc branch July 11, 2023 13:40

Conversation

mehtamohit013 commented May 26, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mehtamohit013 commented May 26, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mehtamohit013 commented May 30, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mehtamohit013 commented May 31, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

edublancas left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

edublancas Jun 1, 2023

Choose a reason for hiding this comment

Uh oh!

mehtamohit013 Jun 1, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

edublancas Jun 1, 2023

Choose a reason for hiding this comment

Uh oh!

mehtamohit013 Jun 2, 2023

Choose a reason for hiding this comment

Uh oh!

mehtamohit013 Jun 2, 2023

Choose a reason for hiding this comment

Uh oh!

mehtamohit013 Jun 3, 2023

Choose a reason for hiding this comment

Uh oh!

edublancas Jun 1, 2023

Choose a reason for hiding this comment

Uh oh!

mehtamohit013 Jun 2, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mehtamohit013 commented Jun 2, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mehtamohit013 commented Jun 5, 2023

Uh oh!

edublancas commented Jun 5, 2023

Uh oh!

mehtamohit013 commented Jun 5, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

mehtamohit013 commented May 26, 2023 •

edited

Loading

mehtamohit013 commented May 26, 2023 •

edited

Loading

mehtamohit013 commented May 31, 2023 •

edited

Loading

edublancas left a comment •

edited

Loading

mehtamohit013 Jun 1, 2023 •

edited

Loading

mehtamohit013 commented Jun 2, 2023 •

edited

Loading