CI: Add test workflow for action #27

matthewfeickert · 2023-07-19T20:03:34Z

Resolves #15

Add simplest example package to tests so that it can be built for upload to Anaconda cloud as a test of the action.
- Use setuptools as the build backend over something like hatchling given the simple nature of the test-package given that anaconda-client v1.12.0 doesn't understand valid metadata from PEP 518 build backends other than setuptools. c.f. anaconda-client doesn't know how to read valid metadata from non-setuptools build backends anaconda/anaconda-client#676
Add CI GitHub Action workflow to test the functionality of the action as shown in the README.

Lines 10 to 17 in 4792bc2

    
           jobs: 
        
             steps: 
        
               ... 
        
               - name: Upload wheel 
        
                 uses: scientific-python/upload-nightly-action@8f0394fd2aa0c85d7364a9958652e8994e06b23c # 0.1.0 
        
                 with: 
        
                   artifacts_path: dist 
        
                   anaconda_nightly_upload_token: ${{secrets.UPLOAD_TOKEN}}

.github/workflows/ci.yml

tests/debug_project/pyproject.toml

matthewfeickert · 2023-07-21T03:07:46Z

.github/workflows/ci.yml

+
+on:
+  push:
+    # branches: [ main ]


Using for debugging. Make sure to revert comment before merge.

matthewfeickert · 2023-07-21T05:56:49Z

Note to reviewers: The CI fails because GitHub Actions is using my fork's credentials to try to run this (as this workflow doesn't exist on the main repo yet) (c.f. https://github.com/scientific-python/upload-nightly-action/pull/27/files#r1270228235). I pushed this branch under a different name as a test to the main repo and it was able to run and upload test-package correctly: https://anaconda.org/scientific-python-nightly-wheels/test-package

So this is working as I would expect, and so is ready for your reviews. 👍

matthewfeickert · 2023-07-27T20:13:50Z

Gentle ping for review when people have time.

MridulS

LGTM!

Maybe we should link this test action from the root README file too?
For example for networkx, we just build and upload. Maybe we should add the verification and debugging steps too 😅

bsipocz · 2023-08-01T20:52:19Z

.github/workflows/ci.yml

+    branches: [ main ]
+  # Run daily at 1:23 UTC
+  schedule:
+  - cron:  '23 1 * * *'


Does this really have to run daily? Weekly, or biweekly should be enough for such a repo.

Because we don't expect fast pace breakings here, as we practically have very few dependencies, and it's totally unnecessary use of resource.

In fact, as I see all versions are pinned, so then there is zero sense in running the cron.

In fact, as I see all versions are pinned, so then there is zero sense in running the cron.

No, the action isn't fully specified (that requires a lock file, which is an upcoming PR), and the ci workflow uses unpinned versions of other actions that you want to know about. So testing on CRON is a good idea. The resource use is trivial IMO, but if it is really offensive we can move it to weekly.

bsipocz · 2023-08-01T20:56:56Z

.github/workflows/ci.yml

+        uses: ./
+        with:
+          artifacts_path: dist
+          anaconda_nightly_upload_token: ${{ secrets.UPLOAD_TOKEN }}


So where would this test package end up being uploaded? Is there any cleanup planned once the upload is successful?

So where would this test package end up being uploaded?

https://anaconda.org/scientific-python-nightly-wheels/test-package

(c.f. #27 (comment))

Is there any cleanup planned once the upload is successful?

No, but does there need to be?

Yes. I would definitely like to avoid polluting the user deployed space with testing artifacts.

I would definitely like to avoid polluting the user deployed space with testing artifacts.

Can you elaborate as to why this matters? Also please suggest an alternative location.

I'm not suggesting another location, but to do a cleanup. Easy and simple and the pollution will be only present when there is a problem.

matthewfeickert · 2023-08-01T20:58:26Z

Maybe we should link this test action from the root README file too? For example for networkx, we just build and upload. Maybe we should add the verification and debugging steps too

@MridulS We could do that, but I would suggest not using this GHA workflow but creating a template that anyone in the org could use, as this workflow is focused on just testing the test package. There are already other projects and Actions that do this and more, like https://github.com/hynek/build-and-inspect-python-package, but I could understand the interest in an action template that would be more specific to a minimum set of verification stages that people can then extend if they want. This would be a separate project though IMO.

While I have personally found benefits in pyhf from having these verification steps I don't think that anyone not using them now should feel bad. Though I agree if we can make adoption even easier that's great.

matthewfeickert · 2023-08-01T21:38:29Z

.github/workflows/ci.yml

+  # Run weekly at 1:23 UTC
+  schedule:
+  - cron:  '23 1 * * 7'


CRON is now weekly.

Oh this is apparently non-standard CRON syntax? Let me fix this. :(

'23 1 * * 7' is nonstandard because of the 7 so I swapped this to 0.

matthewfeickert · 2023-08-01T21:40:31Z

.github/workflows/ci.yml

+  cleanup:
+    runs-on: ubuntu-latest
+    needs: [test]
+    # Set required workflow secrets in the environment for additional security
+    # https://github.com/scientific-python/upload-nightly-action/settings/environments
+    environment:
+      name: remove-old-wheels
+
+    steps:
+      - name: Install micromamba and anaconda-client
+        uses: mamba-org/setup-micromamba@v1
+        with:
+          environment-name: remove-wheels
+          create-args: >-
+            python=3.11
+            anaconda-client
+
+      - name: Remove test package upload
+        run: |
+            anaconda --token ${{ secrets.ANACONDA_TOKEN }} remove \
+              --force \
+              "scientific-python-nightly-wheels/test-package"


This should now remove the test-package package that gets uploaded just previously in the test job.

* Add simplest example package to tests so that it can be built for upload to Anaconda cloud as a test of the action. - Use setuptools as the build backend over something more obvious like hatchling given the simple nature of the test-package given that anaconda-client v1.12.0 doesn't understand valid metadata from PEP 518 build backends other than setuptools. c.f. anaconda/anaconda-client#676 * Add CI GitHub Action workflow to test the functionality of the action as shown in the README.

matthewfeickert · 2023-08-01T21:53:28Z

.github/workflows/ci.yml

+            anaconda-client
+
+      - name: Remove test package upload
+        shell: bash -l {0}


Okay final burst of noise (sorry) to add in this shell line so that conda works in Actions. This works as expected (just tested on a debug branch on the main project).

matthewfeickert · 2023-08-03T19:01:01Z

👋 @bsipocz if you get time before the end of the week can you review if the changes I made given your original comments address them?

bsipocz · 2023-08-09T19:07:41Z

if you get time before the end of the week can you review if the changes I made given your original comments address them?

it would be super nice to allow a quick re-review if commits made after the review were not squashed into the original one. We do squash on merge anyway, so squashing in the PR has no actual benefits.

matthewfeickert · 2023-08-09T19:23:18Z

it would be super nice to allow a quick re-review if commits made after the review were not squashed into the original one.

@bsipocz see #27 (review)

bsipocz

OK, I can't spot any more issues, let's try and see it indeed passes after merge.

matthewfeickert added the CI label Jul 19, 2023

matthewfeickert self-assigned this Jul 19, 2023

matthewfeickert commented Jul 19, 2023

View reviewed changes

.github/workflows/ci.yml Show resolved Hide resolved

matthewfeickert commented Jul 19, 2023

View reviewed changes

.github/workflows/ci.yml Show resolved Hide resolved

matthewfeickert commented Jul 19, 2023

View reviewed changes

tests/debug_project/pyproject.toml Outdated Show resolved Hide resolved

matthewfeickert commented Jul 21, 2023

View reviewed changes

matthewfeickert mentioned this pull request Jul 21, 2023

anaconda-client doesn't know how to read valid metadata from non-setuptools build backends anaconda/anaconda-client#676

Closed

matthewfeickert added this to the 0.2.0 milestone Jul 21, 2023

matthewfeickert force-pushed the ci/add-tests branch from 1ed424a to ff8a2d7 Compare July 21, 2023 04:14

matthewfeickert marked this pull request as ready for review July 21, 2023 04:15

matthewfeickert force-pushed the ci/add-tests branch from 90d7eaf to b25c7f3 Compare July 21, 2023 04:31

matthewfeickert marked this pull request as draft July 21, 2023 04:55

matthewfeickert force-pushed the ci/add-tests branch from b25c7f3 to 0036838 Compare July 21, 2023 05:50

matthewfeickert marked this pull request as ready for review July 21, 2023 05:53

matthewfeickert requested review from stefanv, jarrodmillman and bsipocz July 21, 2023 05:54

matthewfeickert requested review from Carreau and henryiii August 1, 2023 03:55

MridulS approved these changes Aug 1, 2023

View reviewed changes

bsipocz reviewed Aug 1, 2023

View reviewed changes

matthewfeickert force-pushed the ci/add-tests branch from 0036838 to 7919142 Compare August 1, 2023 21:37

matthewfeickert commented Aug 1, 2023

View reviewed changes

matthewfeickert requested a review from bsipocz August 1, 2023 21:40

matthewfeickert force-pushed the ci/add-tests branch from 7919142 to b7c5ac0 Compare August 1, 2023 21:44

matthewfeickert force-pushed the ci/add-tests branch from b7c5ac0 to 0d8a131 Compare August 1, 2023 21:52

matthewfeickert commented Aug 1, 2023

View reviewed changes

matthewfeickert mentioned this pull request Aug 2, 2023

ci: Add distribution verification checks to nightly wheel upload networkx/networkx#6831

Merged

matthewfeickert requested review from bsipocz and removed request for bsipocz August 9, 2023 19:00

bsipocz approved these changes Aug 9, 2023

View reviewed changes

bsipocz merged commit b4720c6 into scientific-python:main Aug 9, 2023
1 of 2 checks passed

matthewfeickert deleted the ci/add-tests branch August 11, 2023 04:03

matthewfeickert mentioned this pull request Aug 15, 2023

MNT: Use conda-lock lock file for reproducible environment #32

Merged

matthewfeickert mentioned this pull request Apr 17, 2024

CI: fix spelling of test package name #79

Merged

matthewfeickert mentioned this pull request Sep 27, 2024

TST: Use hatchling as build backend for test project #92

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

CI: Add test workflow for action #27

CI: Add test workflow for action #27

matthewfeickert commented Jul 19, 2023 •

edited

Loading

matthewfeickert Jul 21, 2023

matthewfeickert commented Jul 21, 2023 •

edited

Loading

matthewfeickert commented Jul 27, 2023

MridulS left a comment

bsipocz Aug 1, 2023

matthewfeickert Aug 1, 2023

bsipocz Aug 1, 2023

matthewfeickert Aug 1, 2023

bsipocz Aug 1, 2023

matthewfeickert Aug 1, 2023 •

edited

Loading

bsipocz Aug 1, 2023

matthewfeickert Aug 1, 2023

bsipocz Aug 1, 2023

matthewfeickert commented Aug 1, 2023

matthewfeickert Aug 1, 2023

matthewfeickert Aug 1, 2023

matthewfeickert Aug 1, 2023

matthewfeickert Aug 1, 2023

matthewfeickert Aug 1, 2023 •

edited

Loading

matthewfeickert commented Aug 3, 2023 •

edited

Loading

bsipocz commented Aug 9, 2023

matthewfeickert commented Aug 9, 2023

bsipocz left a comment

	jobs:
	steps:
	...
	- name: Upload wheel
	uses: scientific-python/upload-nightly-action@8f0394fd2aa0c85d7364a9958652e8994e06b23c # 0.1.0
	with:
	artifacts_path: dist
	anaconda_nightly_upload_token: ${{secrets.UPLOAD_TOKEN}}

CI: Add test workflow for action #27

CI: Add test workflow for action #27

Conversation

matthewfeickert commented Jul 19, 2023 • edited Loading

Choose a reason for hiding this comment

matthewfeickert commented Jul 21, 2023 • edited Loading

matthewfeickert commented Jul 27, 2023

MridulS left a 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

matthewfeickert Aug 1, 2023 • 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

matthewfeickert commented Aug 1, 2023

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

matthewfeickert Aug 1, 2023 • edited Loading

Choose a reason for hiding this comment

matthewfeickert commented Aug 3, 2023 • edited Loading

bsipocz commented Aug 9, 2023

matthewfeickert commented Aug 9, 2023

bsipocz left a comment

Choose a reason for hiding this comment

matthewfeickert commented Jul 19, 2023 •

edited

Loading

matthewfeickert commented Jul 21, 2023 •

edited

Loading

matthewfeickert Aug 1, 2023 •

edited

Loading

matthewfeickert Aug 1, 2023 •

edited

Loading

matthewfeickert commented Aug 3, 2023 •

edited

Loading