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

[Tiny PR] Add updated README files during precommit #18657

Merged
merged 1 commit into from
Nov 25, 2019

Conversation

ellatrix
Copy link
Member

Description

Currently, README.md files are updated during precommit, but the changes are not added. This has been annoying me for a while. Only later on you realise that there are unstaged changes created by ./bin/update-readmes.js and then you need to commit them separately.

Here I've added git add . after node ./bin/update-readmes.js. Note that this doesn't add any other unstaged changes as they are stashed.

How has this been tested?

Update some documentation that would be added to a README.md file. Commit the change. Ensure that the automated README.md change is part of the commit.

Screenshots

Types of changes

Checklist:

  • My code is tested.
  • My code follows the WordPress code style.
  • My code follows the accessibility standards.
  • My code has proper inline documentation.
  • I've included developer documentation if appropriate.
  • I've updated all React Native files affected by any refactorings/renamings in this PR. .

@ellatrix ellatrix added the [Type] Build Tooling Issues or PRs related to build tooling label Nov 21, 2019
@ellatrix ellatrix requested review from ntwb and gziolo November 21, 2019 09:41
Copy link
Contributor

@draganescu draganescu left a comment

Choose a reason for hiding this comment

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

Tested and yes thank you that was annoying :) especially when you are not used to a stack that automagically does so many things.

@ellatrix ellatrix merged commit 0aee2f7 into master Nov 25, 2019
@ellatrix ellatrix deleted the try/precommit-add-readme branch November 25, 2019 16:37
@youknowriad youknowriad added this to the Gutenberg 7.0 milestone Nov 25, 2019
@youknowriad
Copy link
Contributor

This s a very dangerous change IMO, I often have changes locally that I don't want to commit. I'd prefer reverting this personally.

@ellatrix
Copy link
Member Author

@youknowriad Oh, I thought it would only add the readme changes as the rest would be stashed. Let me follow up with a PR.

@aduth
Copy link
Member

aduth commented Nov 25, 2019

I just came across this, since I'm in the same situation as described by @youknowriad and am unable to make a partial commit of files 😬

@ellatrix ellatrix restored the try/precommit-add-readme branch November 25, 2019 21:07
ellatrix added a commit that referenced this pull request Nov 25, 2019
@ellatrix
Copy link
Member Author

@aduth Ok, sorry, I'll work on a fix right away. I thought I saw the unstated changed stashed but apparently they are not.

@aduth
Copy link
Member

aduth commented Nov 25, 2019

@aduth Ok, sorry, I'll work on a fix right away. I thought I saw the unstated changed stashed but apparently they are not.

No rush. I managed to get around it by temporarily reverting the changes from this branch.

More of a "+1" if anything, though I suppose I could have just as well used reactions for that. Sorry to pile on!

@ellatrix
Copy link
Member Author

Created a PR to revert the change.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Type] Build Tooling Issues or PRs related to build tooling
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants