ci: Update CI to use Pixi #971

hoxbro · 2024-10-14T07:43:22Z

Changes the developer/CI from Hatch to Pixi. This will align it with our other repos.

Supersede #970

codecov · 2024-10-14T07:56:23Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.14%. Comparing base (0d191dc) to head (e619273).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #971      +/-   ##
==========================================
+ Coverage   86.45%   87.14%   +0.69%     
==========================================
  Files          10        9       -1     
  Lines        5177     4926     -251     
==========================================
- Hits         4476     4293     -183     
+ Misses        701      633      -68

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

hoxbro · 2024-11-07T11:36:24Z

doc/developer_guide.md

@@ -1,41 +1,189 @@
-# Developer guide
+# Developer Guide


This has been copied from Panel. I should have updated it to match the param, but there could potentially be something I haven't updated correctly.

hoxbro · 2024-11-07T11:38:08Z

.pre-commit-config.yaml

@@ -1,7 +1,7 @@
 # This is the configuration for pre-commit, a local framework for managing pre-commit hooks
 #   Check out the docs at: https://pre-commit.com/

-default_stages: [commit]
+default_stages: [pre-commit]


Stop emitting a warning.

hoxbro · 2024-11-07T11:39:16Z

doc/user_guide/Parameter_Types.ipynb

@@ -717,8 +717,8 @@
    "class P(param.Parameterized):\n",
    "    p = param.Path('Parameter_Types.ipynb')\n",
    "    f = param.Filename('Parameter_Types.ipynb')\n",
-    "    d = param.Foldername('lib', search_paths=['/','/usr','/share'])\n",
-    "    o = param.Filename('output.csv', check_exists=False)\n",
+    "    d = param.Foldername('lib', search_paths=['/','/usr','/share'], check_exists=False)\n",


Changes made in this file are so we can run this notebook on Windows, too.

hoxbro · 2024-11-07T11:40:56Z

pyproject.toml

@@ -39,13 +40,7 @@ examples = [
    "pandas",
    "panel",
 ]
-doc = [


I have removed the developer-focused optional dependencies doc and lint, also coverage.

hoxbro · 2024-11-07T11:41:57Z

tests/testreactive.py

@@ -590,7 +590,7 @@ def gen():
 async def test_reactive_gen_pipe():
    def gen(val):
        yield val+1
-        time.sleep(0.05)
+        time.sleep(0.1)


Avoid the flaky Windows test; use the same fix as #967.

maximlt · 2024-11-07T15:19:52Z

.github/workflows/build.yaml


 jobs:
+  waiting_room:


Does this mean I'll have to click somewhere to release Param? I don't think I've done it yet for other places where you added that. If so, am I supposed to check something specific before I click?

Yes. It is done on the other repos, though I have limited it to lead maintainers (and me).

I use it to double-check that the version tag is correct.

I have limited it to lead maintainers (and me).

Ok. Where is the least of lead maintainers defined?

I use it to double-check that the version tag is correct.

Too bad we no longer trust the system to produce the right version tag, but that's fine.

Too bad we no longer trust the system to produce the right version tag, but that's fine.

The "system" is writing tags ourselves and git push (ref). PyPi also strongly encourages it (ref).

PyPi also strongly encourages it (ref).

I'm sorry I don't understand, this page links to using a trusted publisher. Are we doing that?

I believe we are in places (though maybe not everywhere yet).

I'm sorry I don't understand, this page links to using a trusted publisher. Are we doing that?

Just to be sure:

The waiting room job itself is to ensure that all the building steps succeed. For example, if the PyPi build step fails, the conda package will not be released.

Inside the waiting room is an environment publish, which people must be approved before release. This was what I tried to reference in the PyPI ref.

Ok thanks I got it.

The waiting room job itself is to ensure that all the building steps succeed. For example, if the PyPi build step fails, the conda package will not be released.

It sounds like it's more for manually checking the two builds, since otherwise it could be automated.

Inside the waiting room is an environment publish, which people must be approved before release. This was what I tried to reference in the PyPI ref.

Ok I understand better how you use the environment to add this protection rule. Seems not so related to the trusted publisher thing for which environment is optional but permissions with id-token: write is not.

By the way I think you should add Jean-Luc and we probably need to update the list of maintainers.

All of that sounds like it would be worth being documented somewhere, it's kind of hard to follow.

manually checking the two builds

It is automatically done. If the environment were not there, it would do everything without interaction.

All of that sounds like it would be worth being documented somewhere

Yes. I will update the holoviz site (soon).

maximlt · 2024-11-08T09:28:27Z

.github/workflows/docs.yaml

-      - name: build docs
-        run: hatch -v run docs:build
+
+  docs_publish:


Why is this workflow divided in two jobs?

If the upload fails because of a connection issue, you don't need to build the docs again. However, it is not a big problem in param.

Ah ok, I've never seen that fail before during a docs build. Do you mind simplifying this workflow into one single job? Let's keep things simple!

Let's keep things simple!

I agree, though I think the simplest thing is to align the CI files across projects.

maximlt · 2024-11-08T09:29:35Z

.github/workflows/nightly_lock.yaml

I wonder to which extent this is needed for repositories that a low development activity like Param. I guess it doesn't hurt so much.

Yes, it doesn't hurt. Some reasons, albeit not the most significant problem from param:

Cache is not shared between PRs. So if no lock is run on the main branch, each PR needs to lock it, the first time.

Away to get a snapshot of the environment. This can be used to see what package caused a failure. It could also be used to see how the param environments looked a year ago.

Away to get a snapshot of the environment. This can be used to see what package caused a failure. It could also be used to see how the param environments looked a year ago.

Ah yes I missed that the lock file was pushed to S3 too. Sounds useful, when you know about it ;)

maximlt · 2024-11-08T09:30:55Z

.github/workflows/test.yaml

+          environments: ${{ matrix.environment }}
+      - name: Test Unit
+        run: |
+          pixi run -e ${{ matrix.environment }} test-unit $COV


Maybe add a test-unit-cov command? This is also useful to run as a developer and not just for the CI.

I haven't needed to run coverage locally, but you can also run it with pixi run test-unit --cov=param.

I'm cautious about adding more tasks, which could confuse new contributors.

I liked when you said that you moved as much as possible from the config that was on the CI workflows to the pixi config file (e.g. env vars) which is why I was a little surprised to see that there in test.yaml.

I'm cautious about adding more tasks, which could confuse new contributors.

My experience so far has been to copy/paste the commands displayed in the developer guide. I have not relied on pixi task list which I think just gives a simple list of tasks available without their definition, and that's pretty cluttered already anyway.

I'm fine with how things are anyway here.

maximlt · 2024-11-08T09:33:26Z

pixi.toml

+pytest = "*"
+pytest-asyncio = "*"
+pytest-cov = "*"
+pytest-github-actions-annotate-failures = "*"


Not a big fan of this plugin. It's also definitely not part of the core deps needed to tun the tests.

Not a big fan of this plugin.

I'm a big fan of it. Reduces the need to look into the logs.

It's also definitely not part of the core deps needed to tun the tests.

The same could be set about pytest-cov. The plugin is a no-op if you are not in a Github action and only have pytest as a dependency.

The naming is maybe not the best. A correct name would be test-tools or test-deps — dependencies needed to run the unit tests in every configuration.

I'm a big fan of it. Reduces the need to look into the logs.

My experience of it so far has been to give me the impression that, basically, every Panel PR is failing as it also displays errors that occur during flaky tests.

The same could be set about pytest-cov. The plugin is a no-op if you are not in a Github action and only have pytest as a dependency.

Reminds me of the discussion we recently had about hatch-conda-build :D pytest-cov can be used by a user, I don't think pytest-github-actions-annotate-failures can?

But anyway, I'm again fine with how this is.

My experience of it so far has been to give me the impression that, basically, every Panel PR is failing as it also displays errors that occur during flaky tests.

Yes. There is an open issue for it here pytest-dev/pytest-github-actions-annotate-failures#30.

I think the frustration of it showing up a lot in Panel PRs is a bit misplaced. The correct thing to be frustrated about is the flaky test themselves 🙂

It's not a problem for Param as it doesn't have flaky tests.

The correct thing to be frustrated about is the flaky test themselves 🙂

Both things are frustrating.

maximlt · 2024-11-08T09:35:31Z

scripts/conda/build.sh

+
+python -m build -s .
+
+VERSION=$(python -c "import $PACKAGE; print($PACKAGE._version.__version__)")


Out of curiosity, is there a reason this is not PACKAGE.__version__?

This is to be sure that the automatic version of the file is generated. param.__version__ is more "complex" with try/except.

pyproject.toml

maximlt

Except a typo and a simplification I'd like to see in the docs workflow, I'm fine with these changes.

@hoxbro I would strongly encourage you to update the HoloViz operating guide (https://holoviz.org/contributing.html#operating-guide) now that the workflows you created are used in the majority of places and pyctdev is no longer used in the main repositories. There are many behaviors and explanations as to why things are how they are that are just in your mind and that would be worth sharing with others, current and future contributors/maintainers. If you have custom tooling that is used to inspect/interact with the system you created, it would also be nice to share it in a HoloViz repo.

Co-authored-by: Maxime Liquet <[email protected]>

maximlt

Thanks @hoxbro for doing this work! I'm going to get this merged now as I'd like the next release to use this new infrastructure.

I don't necessarily agree with the increased complexity some workflows got (e.g. publishing waiting room, docs build in two jobs) but I'm not the one doing all the hard work setting up this infra and maintaining it across HoloViz, so it's alright!!

hoxbro added 2 commits October 14, 2024 09:31

ci: Update CI to use Pixi

01e6195

Lint

7b4271b

hoxbro force-pushed the pixi branch from fc1351a to 05ef4f1 Compare October 14, 2024 07:45

Update test.yaml

b7b2fe1

hoxbro force-pushed the pixi branch from 05ef4f1 to b7b2fe1 Compare October 14, 2024 07:47

hoxbro added 3 commits October 14, 2024 09:53

Update test-example task

30d8759

Update pytest options

e5a37d0

Remove pre-commit warning

9b86c11

hoxbro added 3 commits October 14, 2024 09:58

fix lowerbound

59ef7f4

Merge branch 'main' into pixi

c4142f6

fix: Windows examples

9f1acf8

hoxbro force-pushed the pixi branch from 8162619 to 9f1acf8 Compare October 14, 2024 08:37

hoxbro added 13 commits October 14, 2024 10:37

Update pixi.toml

da85896

Try fixing gen on Python 3.13 and Windows

cb16601

lint in docs.yaml

6dfb850

Update docs.yaml to use Pixi

53780af

Update time for test_reactive_gen_py

20fbeeb

lint build.yaml

9fbde59

Update to build to pixi

7d35e0f

Add conda build script

50c741f

Comment out build checks for now

00e1c03

Fix extension of conda build

2916ab5

remove docs env

14b936f

Use .tar.gz for build conda

c61d27b

Add conda-forge channel

942af55

hoxbro force-pushed the pixi branch from 0a6034c to 942af55 Compare November 7, 2024 11:01

hoxbro added 3 commits November 7, 2024 12:02

Uncomment publish step

006e7da

Remove hatch settings from pyproject.toml

49647c6

Remove test-313

45c7f29

hoxbro added 5 commits November 7, 2024 12:24

Update dev. guide

515eb87

remove dev focused optional dependencies from pyproject.toml

b5b46f7

Remove mention of ui test from dev guide

edc0810

Add nighly lock

2d7b1b3

Clean up

b6303e7

hoxbro commented Nov 7, 2024

View reviewed changes

hoxbro marked this pull request as ready for review November 7, 2024 11:44

hoxbro requested a review from maximlt November 7, 2024 11:49

maximlt reviewed Nov 8, 2024

View reviewed changes

maximlt reviewed Nov 9, 2024

View reviewed changes

pyproject.toml Outdated Show resolved Hide resolved

maximlt reviewed Nov 9, 2024

View reviewed changes

Update pyproject.toml

e619273

Co-authored-by: Maxime Liquet <[email protected]>

maximlt approved these changes Nov 12, 2024

View reviewed changes

maximlt merged commit 76c7981 into main Nov 12, 2024
16 checks passed

maximlt deleted the pixi branch November 12, 2024 10:37

maximlt mentioned this pull request Nov 18, 2024

Declare compatibility with Python 3.13 #970

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ci: Update CI to use Pixi #971

ci: Update CI to use Pixi #971

hoxbro commented Oct 14, 2024 •

edited

Loading

codecov bot commented Oct 14, 2024 •

edited

Loading

hoxbro Nov 7, 2024

hoxbro Nov 7, 2024

hoxbro Nov 7, 2024

hoxbro Nov 7, 2024 •

edited

Loading

hoxbro Nov 7, 2024

maximlt Nov 7, 2024

hoxbro Nov 8, 2024

maximlt Nov 9, 2024

hoxbro Nov 11, 2024

maximlt Nov 12, 2024

philippjfr Nov 12, 2024

hoxbro Nov 12, 2024

maximlt Nov 13, 2024

hoxbro Nov 13, 2024

maximlt Nov 8, 2024

hoxbro Nov 8, 2024

maximlt Nov 9, 2024

hoxbro Nov 11, 2024

maximlt Nov 8, 2024

hoxbro Nov 8, 2024

maximlt Nov 9, 2024

maximlt Nov 8, 2024

hoxbro Nov 8, 2024

maximlt Nov 9, 2024

maximlt Nov 8, 2024

hoxbro Nov 8, 2024

maximlt Nov 9, 2024

hoxbro Nov 9, 2024

maximlt Nov 12, 2024

maximlt Nov 8, 2024

hoxbro Nov 8, 2024

maximlt left a comment

maximlt left a comment


		python -m build -s .

		VERSION=$(python -c "import $PACKAGE; print($PACKAGE._version.__version__)")

ci: Update CI to use Pixi #971

ci: Update CI to use Pixi #971

Conversation

hoxbro commented Oct 14, 2024 • edited Loading

codecov bot commented Oct 14, 2024 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hoxbro Nov 7, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

maximlt left a comment

Choose a reason for hiding this comment

maximlt left a comment

Choose a reason for hiding this comment

hoxbro commented Oct 14, 2024 •

edited

Loading

codecov bot commented Oct 14, 2024 •

edited

Loading

hoxbro Nov 7, 2024 •

edited

Loading