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.

Sign up for GitHub

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

Jump to bottom

sage --package create: When re-creating with a different source type, clean up #37352

Merged
merged 4 commits into from
Feb 25, 2024
Merged

sage --package create: When re-creating with a different source type, clean up #37352

merged 4 commits into from
Feb 25, 2024

Conversation

mkoeppe
Copy link
Member

@mkoeppe mkoeppe commented Feb 15, 2024 •
edited

For example, when switching from a pip package to wheel package, remove the requirements.txt file.
When switching from normal to wheel, remove the spkg-install.in file.

One of these cases was handled by a commit on #36641, cherry-picked from there.
Generalizing here to avoid mistakes such as #37129 (comment) in the future.

Example:

$ ./sage -package create imagesize --pypi
Downloading tarball from https://pypi.io/packages/py2.py3/i/imagesize/imagesize-1.4.1-py2.py3-none-any.whl to /Users/mkoeppe/s/sage/sage-rebasing/worktree-pristine/upstream/imagesize-1.4.1-py2.py3-none-any.whl
[......................................................................]
$ git status
On branch sage_package_create_remove_files
Your branch is ahead of 'upstream/develop' by 3 commits.
  (use "git push" to publish your local commits)

Changes not staged for commit:
  (use "git add/rm <file>..." to update what will be committed)
  (use "git restore <file>..." to discard changes in working directory)
	modified:   build/pkgs/imagesize/SPKG.rst
	modified:   build/pkgs/imagesize/checksums.ini
	modified:   build/pkgs/imagesize/install-requires.txt
	deleted:    build/pkgs/imagesize/spkg-install.in
	modified:   build/pkgs/imagesize/type

📝 Checklist

  • The title is concise, informative, and self-explanatory.
  • The description explains in detail what this PR is about.
  • I have linked a relevant issue or discussion.
  • I have created tests covering the changes.
  • I have updated the documentation accordingly.

⌛ Dependencies

@mkoeppe mkoeppe requested a review from kwankyu February 15, 2024 06:45
@mkoeppe mkoeppe mentioned this pull request Feb 15, 2024
Merged
5 tasks
@github-actions GitHub Actions
Copy link

Documentation preview for this PR (built with commit 7f1d531; changes) is ready! 🎉

kwankyu
kwankyu approved these changes Feb 16, 2024
View reviewed changes
Copy link
Collaborator

@kwankyu kwankyu left a comment

Choose a reason for hiding this comment

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

LGTM.

@mkoeppe
Copy link
Member Author

mkoeppe commented Feb 16, 2024

Thank you!

vbraun pushed a commit to vbraun/sage that referenced this pull request Feb 18, 2024
sagemathgh-37352: sage --package create: When re-creating with a di…
6ee097c 
…fferent source type, clean up

    
<!-- ^^^^^
Please provide a concise, informative and self-explanatory title.
Don't put issue numbers in there, do this in the PR body below.
For example, instead of "Fixes sagemath#1234" use "Introduce new method to
calculate 1+1"
-->
<!-- Describe your changes here in detail -->
For example, when switching from a `pip` package to `wheel` package,
remove the `requirements.txt` file.
When switching from `normal` to `wheel`, remove the `spkg-install.in`
file.

One of these cases was handled by a commit on sagemath#36641, cherry-picked from
there.
Generalizing here to avoid mistakes such as
sagemath#37129 (comment) in
the future.

Example:
```
$ ./sage -package create imagesize --pypi
Downloading tarball from https://pypi.io/packages/py2.py3/i/imagesize/im
agesize-1.4.1-py2.py3-none-any.whl to /Users/mkoeppe/s/sage/sage-
rebasing/worktree-pristine/upstream/imagesize-1.4.1-py2.py3-none-any.whl
[......................................................................]
$ git status
On branch sage_package_create_remove_files
Your branch is ahead of 'upstream/develop' by 3 commits.
  (use "git push" to publish your local commits)

Changes not staged for commit:
  (use "git add/rm <file>..." to update what will be committed)
  (use "git restore <file>..." to discard changes in working directory)
        modified:   build/pkgs/imagesize/SPKG.rst
        modified:   build/pkgs/imagesize/checksums.ini
        modified:   build/pkgs/imagesize/install-requires.txt
        deleted:    build/pkgs/imagesize/spkg-install.in
        modified:   build/pkgs/imagesize/type
```

<!-- Why is this change required? What problem does it solve? -->
<!-- If this PR resolves an open issue, please link to it here. For
example "Fixes sagemath#12345". -->
<!-- If your change requires a documentation PR, please link it
appropriately. -->

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->
<!-- If your change requires a documentation PR, please link it
appropriately -->
<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
<!-- Feel free to remove irrelevant items. -->

- [x] The title is concise, informative, and self-explanatory.
- [x] The description explains in detail what this PR is about.
- [ ] I have linked a relevant issue or discussion.
- [ ] I have created tests covering the changes.
- [ ] I have updated the documentation accordingly.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on
- sagemath#12345: short description why this is a dependency
- sagemath#34567: ...
-->

<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
    
URL: sagemath#37352
Reported by: Matthias Köppe
Reviewer(s): Kwankyu Lee, Matthias Köppe
vbraun pushed a commit to vbraun/sage that referenced this pull request Feb 19, 2024
sagemathgh-37352: sage --package create: When re-creating with a di…
06625e2 
…fferent source type, clean up

    
<!-- ^^^^^
Please provide a concise, informative and self-explanatory title.
Don't put issue numbers in there, do this in the PR body below.
For example, instead of "Fixes sagemath#1234" use "Introduce new method to
calculate 1+1"
-->
<!-- Describe your changes here in detail -->
For example, when switching from a `pip` package to `wheel` package,
remove the `requirements.txt` file.
When switching from `normal` to `wheel`, remove the `spkg-install.in`
file.

One of these cases was handled by a commit on sagemath#36641, cherry-picked from
there.
Generalizing here to avoid mistakes such as
sagemath#37129 (comment) in
the future.

Example:
```
$ ./sage -package create imagesize --pypi
Downloading tarball from https://pypi.io/packages/py2.py3/i/imagesize/im
agesize-1.4.1-py2.py3-none-any.whl to /Users/mkoeppe/s/sage/sage-
rebasing/worktree-pristine/upstream/imagesize-1.4.1-py2.py3-none-any.whl
[......................................................................]
$ git status
On branch sage_package_create_remove_files
Your branch is ahead of 'upstream/develop' by 3 commits.
  (use "git push" to publish your local commits)

Changes not staged for commit:
  (use "git add/rm <file>..." to update what will be committed)
  (use "git restore <file>..." to discard changes in working directory)
        modified:   build/pkgs/imagesize/SPKG.rst
        modified:   build/pkgs/imagesize/checksums.ini
        modified:   build/pkgs/imagesize/install-requires.txt
        deleted:    build/pkgs/imagesize/spkg-install.in
        modified:   build/pkgs/imagesize/type
```

<!-- Why is this change required? What problem does it solve? -->
<!-- If this PR resolves an open issue, please link to it here. For
example "Fixes sagemath#12345". -->
<!-- If your change requires a documentation PR, please link it
appropriately. -->

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->
<!-- If your change requires a documentation PR, please link it
appropriately -->
<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
<!-- Feel free to remove irrelevant items. -->

- [x] The title is concise, informative, and self-explanatory.
- [x] The description explains in detail what this PR is about.
- [ ] I have linked a relevant issue or discussion.
- [ ] I have created tests covering the changes.
- [ ] I have updated the documentation accordingly.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on
- sagemath#12345: short description why this is a dependency
- sagemath#34567: ...
-->

<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
    
URL: sagemath#37352
Reported by: Matthias Köppe
Reviewer(s): Kwankyu Lee, Matthias Köppe
@vbraun vbraun merged commit 686f7e9 into sagemath:develop Feb 25, 2024
17 of 23 checks passed
@mkoeppe mkoeppe added this to the sage-10.3 milestone Mar 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kwankyu kwankyu kwankyu approved these changes

Assignees
No one assigned
Labels
c: scripts
Projects
None yet
Milestone
sage-10.3
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@mkoeppe @kwankyu @vbraun