Skip to content

skpkg: setup CI after migrating tests, src, requirements, and .github folder #80

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

Closed
wants to merge 9 commits into from

Conversation

tinatn29
Copy link

No description provided.

@tinatn29 tinatn29 marked this pull request as draft June 17, 2025 20:18
@tinatn29 tinatn29 marked this pull request as ready for review June 17, 2025 20:18
Copy link
Contributor

@sbillinge sbillinge left a comment

Choose a reason for hiding this comment

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

Great to see this! Thanks for doing it @tinatn29

Please see inline comments. Here are some general thoughts.

  1. you seem to have deleted tests-on-pr.yml whic we don't want to do. this runs our CI.
  2. Are there instructions for "updating package" that are different from 'migrating legacy code'? If there are (I am not sure if they were finalized and/or posted but we can find out form @bobleesj and @cadenmyers13 ) but if they are available, we want to be following them here. They will tell you that we want to extend dates, not replace them, and also delete template functions in the docs/tests. These are put there to "seed" a new project like function.py and test_functions.py.

I also see a pre-commit fix that was done in the CI. Please make sure you have pre-commit running locally to catch as many of these on your local before they reach the CI.

Other than this, this is great!

But all in all

@@ -1,7 +1,7 @@
#!/usr/bin/env python
##############################################################################
#
# (c) 2022-2025 The Trustees of Columbia University in the City of New York.
# (c) 2025 The Trustees of Columbia University in the City of New York.
Copy link
Contributor

Choose a reason for hiding this comment

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

we would like to keep the full date range here, so 2022-2025

@@ -1,10 +1,10 @@
#!/usr/bin/env python
##############################################################################
#
# (c) 2022-2025 The Trustees of Columbia University in the City of New York.
# (c) 2025 The Trustees of Columbia University in the City of New York.
Copy link
Contributor

Choose a reason for hiding this comment

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

date range

@@ -1,13 +1,13 @@
#!/usr/bin/env python
##############################################################################
#
# (c) 2022-2025 The Trustees of Columbia University in the City of New York.
# (c) 2025 The Trustees of Columbia University in the City of New York.
Copy link
Contributor

Choose a reason for hiding this comment

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

date

@bobleesj
Copy link
Contributor

Are there instructions for "updating package" that are different from 'migrating legacy code'?

@sbillinge no. We don't have it. Since @cadenmyers13 and others are actively recutting, maybe you could make one?

@sbillinge
Copy link
Contributor

Are there instructions for "updating package" that are different from 'migrating legacy code'?

@sbillinge no. We don't have it. Since @cadenmyers13 and others are actively recutting, maybe you could make one?

I won't be able to get to this personally for some time. I think Ethan was discussing it. @cadenmyers13 do you remember?

@cadenmyers13
Copy link
Contributor

@sbillinge I don't remember (@ycexiao can you confirm Simon's comment?). fyi i tried running package update conda-forge on diffpy.fourigui/main after pip installing skpkg and I got a JSonDecodeError. so maybe its not working quite yet?

@tinatn29
Copy link
Author

tinatn29 commented Jun 18, 2025

@sbillinge @cadenmyers13 I don't know how tests-on-pr.yml got deleted.... I am retrieving it from the main branch. Let me know if this looks okay.

Copy link
Contributor

@sbillinge sbillinge left a comment

Choose a reason for hiding this comment

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

everything looks good now that the CI is back. We can either close this and redo everything as we discussed in the other PR (it is a bit worrying that the .github workflows disappeared before, so it may be safer to redo in case anything else is wrong). I could also merge this as most of the fixes look good, I recognize them! Before I can merge it we need to remove the function.py and test_function.py files using git rm (which will remove them from the git database and the file system)

@ycexiao
Copy link

ycexiao commented Jun 18, 2025

@sbillinge I don't remember (@ycexiao can you confirm Simon's comment?)

I think we don't have the recutting instructions. But we do have a talk mentioning this in scikit-package/scikit-package#527. Our final decision is to implement commands like package update public, and no need to write documentation for this right now.

@tinatn29
Copy link
Author

closing this one since I'm working on a new PR

@tinatn29 tinatn29 closed this Jun 18, 2025
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.

5 participants