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.

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

Fix a bug in retrofit-worktree.sh #38676

Merged
merged 2 commits into from
Sep 29, 2024
Merged

Conversation

kwankyu
Copy link
Collaborator

@kwankyu kwankyu commented Sep 19, 2024

as shown in https://github.com/sagemath/sage/actions/runs/10919536449/job/30307397930?pr=38659, where the error message

[sagemath_doc_html-none] [spkg-install] [installat] /sage/src/doc/en/installation/linux.rst: WARNING: document isn't included in any toctree

is due to the file src/doc/en/installation/linux.rst that is not cleaned up in the "new" branch being tested.

The problem is that the script does not clean the worktree well enough when checking out the "new" branch.

Test: https://github.com/sagemath/sage/actions/runs/10934323900/job/30354225389?pr=38659, an excerpt from which is

#30 6.340 + cd worktree-pre
#30 6.340 + git add -A
#30 6.989 + git commit --quiet --allow-empty -m old -a
#30 7.071 + git tag -f old
#30 7.073 + git checkout -f new
#30 7.106 Previous HEAD position was 98054dd old
#30 7.106 HEAD is now at b05f634 new
#30 7.107 + git clean -fd
#30 7.159 Removing src/doc/en/installation/linux.rst
#30 7.159 + git status
#30 7.243 HEAD detached at new
#30 7.243 nothing to commit, working tree clean

📝 Checklist

  • The title is concise and informative.
  • 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 and checked the documentation preview.

⌛ Dependencies

@kwankyu kwankyu changed the title Fix a bug in retrofit Fix a bug in retrofit-worktree.sh Sep 19, 2024
@kwankyu kwankyu added p: CI Fix merged before running CI tests labels Sep 19, 2024
Copy link

github-actions bot commented Sep 19, 2024

Documentation preview for this PR (built with commit 63f5007; changes) is ready! 🎉
This preview will update shortly after each push to this PR.

Copy link
Contributor

@mkoeppe mkoeppe left a comment

Choose a reason for hiding this comment

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

LGTM, let's try it with this change.

@kwankyu
Copy link
Collaborator Author

kwankyu commented Sep 26, 2024

Thanks!

vbraun pushed a commit to vbraun/sage that referenced this pull request Sep 27, 2024
    
<!-- ^ Please provide a concise and informative title. -->
<!-- ^ Don't put issue numbers in the title, do this in the PR
description below. -->
<!-- ^ For example, instead of "Fixes sagemath#12345" use "Introduce new method
to calculate 1 + 2". -->
<!-- v Describe your changes below in detail. -->
<!-- v Why is this change required? What problem does it solve? -->
<!-- v If this PR resolves an open issue, please link to it here. For
example, "Fixes sagemath#12345". -->

as shown in https://github.com/sagemath/sage/actions/runs/10919536449/jo
b/30307397930?pr=38659, where the error message
```
[sagemath_doc_html-none] [spkg-install] [installat]
/sage/src/doc/en/installation/linux.rst: WARNING: document isn't
included in any toctree
```
is due to the file `src/doc/en/installation/linux.rst` that is not
cleaned up in the "new" branch being tested.

The problem is that the script does not clean the worktree well enough
when checking out the "new" branch.

Test: https://github.com/sagemath/sage/actions/runs/10934323900/job/3035
4225389?pr=38659, an excerpt from which  is
```
sagemath#30 6.340 + cd worktree-pre
sagemath#30 6.340 + git add -A
sagemath#30 6.989 + git commit --quiet --allow-empty -m old -a
sagemath#30 7.071 + git tag -f old
sagemath#30 7.073 + git checkout -f new
sagemath#30 7.106 Previous HEAD position was 98054dd old
sagemath#30 7.106 HEAD is now at b05f634 new
sagemath#30 7.107 + git clean -fd
sagemath#30 7.159 Removing src/doc/en/installation/linux.rst
sagemath#30 7.159 + git status
sagemath#30 7.243 HEAD detached at new
sagemath#30 7.243 nothing to commit, working tree clean
```

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->

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

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on. For example,
-->
<!-- - sagemath#12345: short description why this is a dependency -->
<!-- - sagemath#34567: ... -->
    
URL: sagemath#38676
Reported by: Kwankyu Lee
Reviewer(s): Matthias Köppe
@vbraun vbraun merged commit ab26b13 into sagemath:develop Sep 29, 2024
20 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
p: blocker / 1 p: CI Fix merged before running CI tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants