Irremoteesp8266: update of library maintainers guide wiki

Created on 29 May 2020  路  3Comments  路  Source: crankyoldgit/IRremoteESP8266

@NiKiZe Can you cast any eye over this please:
https://github.com/crankyoldgit/IRremoteESP8266/wiki/Library-Maintainers-Guide/_compare/38264cbc1436416cf35ac17c90254b7b4981471f

I think it's correct, but just want a second set of eyes to review that it's easy enough to follow.

Ta.

help wanted

Most helpful comment

It looks good, I only have comments about git usage, feel free to ignore them, as what is there now works.

git pull always does a git fetch as well, so no need for both, the last git pull can in default configuration be replaced with git merge but normally you don't want a merge there, so
I would recommend git fetch origin; git checkout master; git reset --hard origin/master
That would get you a clean state, but needs due warning about any local changes being lost.

another optimize

  $ git fetch; git checkout master; git pull
  $ git checkout gh-pages
  $ git pull
  $ git merge -s subtree master
  $ git push

to:

  $ git fetch
  $ git checkout gh-pages
  $ git reset --hard origin/gh-pages
  $ git merge -s subtree origin/master
  $ git push

there is no need to have an up to date local master, only care about origin/master

All 3 comments

It looks good, I only have comments about git usage, feel free to ignore them, as what is there now works.

git pull always does a git fetch as well, so no need for both, the last git pull can in default configuration be replaced with git merge but normally you don't want a merge there, so
I would recommend git fetch origin; git checkout master; git reset --hard origin/master
That would get you a clean state, but needs due warning about any local changes being lost.

another optimize

  $ git fetch; git checkout master; git pull
  $ git checkout gh-pages
  $ git pull
  $ git merge -s subtree master
  $ git push

to:

  $ git fetch
  $ git checkout gh-pages
  $ git reset --hard origin/gh-pages
  $ git merge -s subtree origin/master
  $ git push

there is no need to have an up to date local master, only care about origin/master

Yeah, that's a much better/safer approach. I've be so used to being the only one committing to master that my master branch would always be a clean update.

Please check over my update at: https://github.com/crankyoldgit/IRremoteESP8266/wiki/Library-Maintainers-Guide#new-version-release-checklist to check I got what you said correct.

If so, we can mark this resolved.

Look good

Was this page helpful?
0 / 5 - 0 ratings

Related issues

wizkidorg picture wizkidorg  路  7Comments

alwashe picture alwashe  路  5Comments

bwint picture bwint  路  4Comments

andreimos picture andreimos  路  3Comments

ilyasrois picture ilyasrois  路  3Comments