add git-wip and git-unwip #669

acant · 2017-07-26T06:13:11Z

git-wip will commit all the changes in the working directory into a WIP commit
git-unwip will undo a WIP commit using git-undo

I have been using these commands for a while, to save interim changes when switching between feature branches. This ideas in other places, but it would be nice to included it here too. I have added links to files in https://github.com/ddollar/git-utils which are similar, but the scripts are not exactly the same.

Any feedback is welcome. I went through the contributing guidelines, but if I have missed anything I am happy to updated it.

Thanks in advance.

eMPee584 · 2024-12-12T10:43:49Z

Hm, kinda sounds like git stash to me.. Maybe you can check whether this is still useful today?

acant · 2025-01-10T01:00:45Z

@eMPee584 it is very similar to git stash, I agree.
I do still use this script today. When I am working on multiple independent branches I find the wip commit easier to manage that trying to keep a stash of independent commits.
I also like being able to push the wip commits to a remote repo both for safe keeping or for sharing between laptop/desktop systems.

acant · 2025-01-12T17:05:47Z

Rebased onto main instead of master to clean up the conflicts.

hyperupcall

Thanks for the rebase! Generally looks good to me, had two suggestions

hyperupcall · 2025-01-16T20:59:47Z

bin/git-unwip

+
+if [ 'WIP' != $LAST_COMMIT ]; then
+  echo 'Last commit is not a WIP commit, so it will not be unWIP-ed.'
+  exit


Suggested change

exit

exit 1

I think this should be an error if it is unable "to unwip"

That makes sense I will update the commit. 👍

hyperupcall · 2025-01-16T21:01:27Z

bin/git-unwip

+# * https://github.com/ddollar/git-utils/blob/master/git-unwip
+
+# Check if the last commit is a 'WIP' commit
+LAST_COMMIT=`git log -1 --pretty=%B | tr --delete '[:space:]'`


Suggested change

LAST_COMMIT=`git log -1 --pretty=%B | tr --delete '[:space:]'`

LAST_COMMIT=`git log -1 --pretty=%B | tr -d '[:space:]'`

BSD tr doesn't seem to support --delete

Well, that is unfortunate. I have been trying to use the full flag names in scripts, but you are right that BSD does not support it. ☹️

I will update to use -d as you suggested.

acant · 2025-01-26T00:03:53Z

@hyperupcall thanks for approving the workflow execution.

I have tried to fix the various failures in:

build by adding git-wip/unwip to the man/git-extras.md and re-generating with the make command.
typo by adding codespell inline ignore comments. (My last name is "Cant". 😄)
https://github.com/codespell-project/codespell?tab=readme-ov-file#ignoring-words
Unable to add inline comments for markdown documents codespell-project/codespell#3396

acant · 2025-01-26T04:14:17Z

@hyperupcall thanks again for running the workflow.
Looks like I successfully fixed the build stage, but not the typo.

After some investigation is seems that the problem is the version of codespell, which does not include the inline ignore support.

I have created a separate commit to upgrade codespell, which updates tests/pyproject.tom and tests/poetry.lock.
I also ran the codespell command locally and it works on my machine.

Hopefully it will work in Github Actions too. 🤞

hyperupcall · 2025-01-27T18:48:59Z

Thanks! Inline ignoring seems to work fine, although CI still unfortunately fails on spellcheck. I haven't properly been able to look into it because of my schedule at the moment - though I will later

hyperupcall · 2025-01-27T18:53:10Z

I think probably the newer version of codespell is catching typos or "typos" that weren't caught before. Once those issues are fixed then I'll be able to merge this (to keep CI green on main). I'll be able to get around to doing it maybe in a week or two if its not already done

acant · 2025-01-28T01:45:49Z

@hyperupcall I fixed one problem, can caused another. 😆

I just updated the codespell commit to include the spelling fix, and updated the commit message. I re-ran codespell locally, and it seemed to report no errors. Hopefully it will run green now.

Thanks again for your time and attention, it is much appreciated.

hyperupcall · 2025-01-28T04:19:09Z

Fantastic! It's green now. Everything LGTM, I just have to pass it off to @spacewander now

spacewander

Thanks! Just a few comments.

Commands.md

man/git-extras.1

acant · 2025-02-13T05:08:05Z

@spacewander I have updated the commit with git undo --soft and dropping the man/git-extras.* changes , and it is ready for review.
Thanks again for your time. And please let me know if there are any more changes to make.

spacewander · 2025-02-13T09:59:52Z

man/git-summary.1

@@ -1,6 +1,6 @@
-.\" generated with Ronn-NG/v0.9.1


Why touch the git-summary?

This was updated because of a spelling error which was noticed by the latest version of codespell.
I upgraded codespell so that I would be able to use the inline disabled comments.
I need this because my last name "Cant" gets flagged as a spelling error.

man/git-extras.1

acant · 2025-02-16T02:43:21Z

@spacewander when you are ready to re-run the workflow, I have updated the git-extras.* files added the make -C .. man/git-extras.{1,html} command back into the commit message.

Please let me know if there is anything which needs to be changed. Thanks again for your time.

(P.S.: Would it be helpful to add make -C .. man/git-extras.{1,html} and instructions about updating Commands.md/man/index.txt/man/git-extras.md to the man/Readme.md? If yes, then I can open a separate PR.)

spacewander · 2025-02-17T02:26:55Z

Commands.md

+
+## git unwip
+
+Undo A Work In Progress(WIP) commit and put all of those changes back into the


Suggested change

Undo A Work In Progress(WIP) commit and put all of those changes back into the

Undo a Work In Progress(WIP) commit and put all of those changes back into the

I have updated the commit with this change.

spacewander · 2025-02-17T02:30:19Z

(P.S.: Would it be helpful to add make -C .. man/git-extras.{1,html} and instructions about updating Commands.md/man/index.txt/man/git-extras.md to the man/Readme.md? If yes, then I can open a separate PR.)

Thanks. Let's submit a new PR for it.

etc/git-extras-completion.zsh

spacewander · 2025-02-17T14:21:37Z

man/git-wip.html

+
+<h2 id="AUTHOR">AUTHOR</h2>
+
+<p>Written by Andrew Sullivan Cant &lt;<a href="mailto:[email protected]" data-bare-link="true">[email protected]</a>&gt; <!-- codespell:ignore Cant --></p>


It seems the generated HTML files don't handle the <!-- correctly. What about adding the word to https://github.com/tj/git-extras/blob/main/.github/.ignore_words?

That sounds like a possibility. Let me see if I can fix the comment first, and if not I will add to the ignore word list.

Hi @spacewander,

Sorry for the long delay. I finally got to have a look at the codespell ignore issue, and moved "Cant" into the .ignore_words file as you suggested. I re-ran the codespell command locally and re-generated the HTML, so hopefully this is all ready to go.

Thanks for your time and attention.

spacewander · 2025-05-13T11:21:19Z

@acant
Would you solve the conflict so we can rerun the CI?

acant · 2025-05-13T14:37:42Z

@spacewander sorry, I thought I had fixed that. I will get that resolved later today.

It is a lastet verison, and is needed so that I can use the inline ignore support in a future commit. After updating tests/pyproject.toml I ran the following commands: ``` cd tests poetry lock --no-update poetry install ``` I also fixed a spelling error in man/git-summary.md, which was not caught by the old version of codespell. After updating the file I also updated the related files by running the following commands: ``` cd man make -C .. man/git-summary.{1,html} ```

Updated/re-built the documentation with: ``` cd man make -C .. man/git-unwip.{1,html} make -C .. man/git-wip.{1,html} make -C .. man/git-extras.{1,html} ```

acant · 2025-05-13T14:42:39Z

@spacewander that was easier than I thought. :) The conflict is fixed, and hopefully ready to merge now.

spacewander · 2025-05-14T09:07:48Z

@acant
Merged. Thanks!

acant force-pushed the feature/wip_unwip branch from aa5affa to 3a22a42 Compare July 30, 2017 02:28

acant force-pushed the feature/wip_unwip branch 3 times, most recently from 4501c4a to 71395a3 Compare January 12, 2025 17:02

hyperupcall requested changes Jan 16, 2025

View reviewed changes

acant force-pushed the feature/wip_unwip branch from 71395a3 to 8915f7c Compare January 24, 2025 05:02

acant requested a review from hyperupcall January 24, 2025 05:03

acant force-pushed the feature/wip_unwip branch 2 times, most recently from a792dac to 0165853 Compare January 26, 2025 00:00

acant force-pushed the feature/wip_unwip branch from 0165853 to 720beae Compare January 26, 2025 04:07

acant force-pushed the feature/wip_unwip branch from 720beae to afe19c1 Compare January 28, 2025 01:40

hyperupcall approved these changes Jan 28, 2025

View reviewed changes

hyperupcall requested a review from spacewander January 28, 2025 04:19

spacewander reviewed Feb 5, 2025

View reviewed changes

Commands.md Outdated Show resolved Hide resolved

man/git-extras.1 Show resolved Hide resolved

acant force-pushed the feature/wip_unwip branch from b8868f3 to 37d477e Compare February 13, 2025 04:54

spacewander reviewed Feb 13, 2025

View reviewed changes

acant force-pushed the feature/wip_unwip branch 2 times, most recently from 820457a to 9e0fbe7 Compare February 16, 2025 02:41

acant requested a review from spacewander February 17, 2025 00:59

spacewander approved these changes Feb 17, 2025

View reviewed changes

acant force-pushed the feature/wip_unwip branch from 9e0fbe7 to 69b20f8 Compare February 17, 2025 02:51

spacewander reviewed Feb 17, 2025

View reviewed changes

etc/git-extras-completion.zsh Outdated Show resolved Hide resolved

acant force-pushed the feature/wip_unwip branch from 69b20f8 to bbda815 Compare February 17, 2025 07:06

spacewander reviewed Feb 17, 2025

View reviewed changes

acant force-pushed the feature/wip_unwip branch from bbda815 to 3821295 Compare May 13, 2025 05:31

acant added 2 commits May 13, 2025 10:41

add git-wip and git-unwip

b9ba50b

Updated/re-built the documentation with: ``` cd man make -C .. man/git-unwip.{1,html} make -C .. man/git-wip.{1,html} make -C .. man/git-extras.{1,html} ```

acant force-pushed the feature/wip_unwip branch from 3821295 to b9ba50b Compare May 13, 2025 14:41

spacewander approved these changes May 14, 2025

View reviewed changes

spacewander merged commit c63b46a into tj:main May 14, 2025
6 checks passed

BrewTestBot mentioned this pull request Jun 20, 2025

git-extras 7.4.0 Homebrew/homebrew-core#227588

Merged

	LAST_COMMIT=`git log -1 --pretty=%B \| tr --delete '[:space:]'`
	LAST_COMMIT=`git log -1 --pretty=%B \| tr -d '[:space:]'`


		## git unwip

		Undo A Work In Progress(WIP) commit and put all of those changes back into the


		<h2 id="AUTHOR">AUTHOR</h2>

		<p>Written by Andrew Sullivan Cant <<a href="mailto:[email protected]" data-bare-link="true">[email protected]</a>> <!-- codespell:ignore Cant --></p>

add git-wip and git-unwip #669

add git-wip and git-unwip #669

Uh oh!

Conversation

acant commented Jul 26, 2017

Uh oh!

eMPee584 commented Dec 12, 2024

Uh oh!

acant commented Jan 10, 2025

Uh oh!

acant commented Jan 12, 2025

Uh oh!

hyperupcall left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

acant commented Jan 26, 2025

Uh oh!

acant commented Jan 26, 2025

Uh oh!

hyperupcall commented Jan 27, 2025

Uh oh!

hyperupcall commented Jan 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

acant commented Jan 28, 2025

Uh oh!

hyperupcall commented Jan 28, 2025

Uh oh!

spacewander left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

acant commented Feb 13, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

acant commented Feb 16, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

spacewander commented Feb 17, 2025

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

spacewander commented May 13, 2025

Uh oh!

acant commented May 13, 2025

Uh oh!

acant commented May 13, 2025

Uh oh!

Uh oh!

spacewander commented May 14, 2025

Uh oh!

Uh oh!

hyperupcall left a comment •

edited

Loading

hyperupcall commented Jan 27, 2025 •

edited

Loading