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

docs: add link to auto-commit docs to quick-start.md #4265

Closed
wants to merge 1 commit into from

Conversation

CanRau
Copy link
Contributor

@CanRau CanRau commented Feb 9, 2025

Stumbled upon this in the quick start guide

chezmoi can be configured to automatically add, commit, and push changes to your repo.

tho it took me a while to find the actual docs on how to configure that also tried clicking, so I figured why not include a link

@halostatue
Copy link
Collaborator

Thank you for your contribution, but there are some issues to resolve before it can be merged.

@CanRau
Copy link
Contributor Author

CanRau commented Feb 10, 2025

Sure, I wasn't sure which part to link etc so figured I just open with one possibility and see what happens 😉
Anything else?

@halostatue
Copy link
Collaborator

I’ll run a test to make sure that the relative URL that I provided is correct, but that won't be until this evening.

Copy link
Collaborator

@halostatue halostatue left a comment

Choose a reason for hiding this comment

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

The link was not correct, because daily-operations is in the user-guide and is its own page. I have suggested to correct link.

Once you fix this in your branch, please rebase/squash your commits to a single commit and we can get this merged.

Apologies for the delay; I have been both under the weather and busy with other stuff.

Stumbled upon
> chezmoi can be configured to automatically add, commit, and push changes to your repo.
tho it took me a while to find the actual docs on how to configure that also tried clicking, so I figured why not include a link

update link

Update assets/chezmoi.io/docs/quick-start.md

Co-authored-by: Austin Ziegler <[email protected]>
@CanRau
Copy link
Contributor Author

CanRau commented Feb 16, 2025

Sorry for the delay 🙏🏼

Like this?

@halostatue
Copy link
Collaborator

Sorry for the delay 🙏🏼

Like this?

This is close to what we previously wanted, but there are couple of changes required because of a large documentation change I made and just merged. It's easy, though.

  1. First, rebase against the current twpyane/chezmoi:master branch. You may get a conflict on this line, but the change is approximately on line 84 still, so you shouldn't.

  2. Second, change lines 84 and 85 to read as follows:

       chezmoi can be configured to automatically [add, commit, and push][autogit]
       changes to your repo.
  3. Third, add the following line after line 230:

    [autogit]: /user-guide/daily-operations.md#automatically-commit-and-push-changes-to-your-repo
  4. Finally, update your commit and commit message with:

    git commit --amend -a -m 'docs: Add link to auto-commit docs to quick start'

    All commit messages must begin with a capital letter after the prefix.

halostatue pushed a commit to halostatue/chezmoi that referenced this pull request Feb 22, 2025
@halostatue
Copy link
Collaborator

I have added this as part of #4290. I cherry-picked your commit, so you should still be credited for the change, but there is a release coming soon and I wanted to ensure that the documentation is up-to-date.

@CanRau
Copy link
Contributor Author

CanRau commented Feb 22, 2025

Hey sorry your last comment got kinda lost in my notifications 🫣

Of course I'm more interested in helping than taking credit, if my name's in there great if not don't worry 🤷🏻‍♂️❤️

@twpayne twpayne closed this in 65e5b29 Feb 23, 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.

2 participants