BoostNote-Legacy icon indicating copy to clipboard operation
BoostNote-Legacy copied to clipboard

GitHub sync

Open chrisstpierre opened this issue 6 years ago • 10 comments

Description

This PR Adds a local git repo as a possible storage option. Two additional options are included (1. Autosync changes with Github. 2. Manually sync note changes to github by clicking a sync button).

When Type: Git Repo is selected, an existing git repository must be chosen. With Auto Sync selected, changes are committed and pushed every 30 seconds with no user action necessary. With Commit Manually selected, a sync icon in the top right appears when the present note is out of sync. Pressing this syncs the note (commits and pushes)

Screen Shot 2019-10-04 at 6 31 06 PM Screen Shot 2019-10-04 at 6 31 31 PM

Issue fixed

#2792, #1085

Type of changes

  • :white_circle: Bug fix (Change that fixed an issue)
  • :white_circle: Breaking change (Change that can cause existing functionality to change)
  • :white_circle: Improvement (Change that improves the code. Maybe performance or development improvement)
  • :radio_button: Feature (Change that adds new functionality)
  • :white_circle: Documentation change (Change that modifies documentation. Maybe typo fixes)

Checklist:

  • :radio_button: My code follows the project code style
  • :white_circle: I have written test for my code and it has been tested
  • :radio_button: All existing tests have been passed
  • :radio_button: I have attached a screenshot/video to visualize my change if possible

IssueHunt Summary

Referenced issues

This pull request has been submitted to:


IssueHunt has been backed by the following sponsors. Become a sponsor

chrisstpierre avatar Oct 04 '19 15:10 chrisstpierre

Could you elaborate on this PR by adding a description and providing images of the new functionality? Reviewers shouldn't have to figure out what everything does from just your code.

Flexo013 avatar Nov 04 '19 18:11 Flexo013

Could you elaborate on this PR by adding a description and providing images of the new functionality? Reviewers shouldn't have to figure out what everything does from just your code.

Sorry, there was actually a description & screen shots included, but they were commented out for some reason. Please review the updated description.

I think the sync button icon should be updated to match the current style, but I'll let others comment on that

After someone reviews I can write some unit tests before a merge is accepted

chrisstpierre avatar Nov 15 '19 04:11 chrisstpierre

How does your code handle when conflicts occur?

While the intention of this PR isn't to add the possibility of having multiple people work on the same notes, I still think people are going to use it that way, so that's why I'm asking.

Flexo013 avatar Nov 15 '19 15:11 Flexo013

@Flexo013 it does pull before pushing as a part of the sync process, but it wouldn't work very well currently for the situation you describe:

  • The local branch would not be updated until a sync occurs, so the user may be working on something that appears outdated until they try to sync their changes
  • If there is a merge conflict then it would need to be resolved manually
  • Working on the same note at the same time brings up a few other questions, such as how often the rendered view is updated.

chrisstpierre avatar Nov 19 '19 22:11 chrisstpierre

@chrisstpierre @Flexo013 Is there any update on the current progress of merging this into master?

fklement avatar Feb 03 '20 14:02 fklement

@chrisstpierre can you fix the conflict please? Thank you.

ZeroX-DG avatar Feb 06 '20 07:02 ZeroX-DG

@ZeroX-DG If I get permission to add something to this retrieval request, then I could do that too. Really looking forward to this feature.

fklement avatar Feb 06 '20 10:02 fklement

@fklement you can take over this PR and continue the work on a different PR if you wish to:) I think the creator of this PR lost interest in this.

ZeroX-DG avatar Feb 08 '20 04:02 ZeroX-DG

@ZeroX-DG All right, then I'll take over the PR and create a new one.

fklement avatar Feb 08 '20 09:02 fklement

@ZeroX-DG Just so you know I'm still fixing and adding to that PR. Unfortunately I have too much other things to do right now. But when I have more free time, I'm going to tackle this one!

fklement avatar Mar 05 '20 08:03 fklement