[Tutorial] How to get help

[Mara-Li]

Sometimes, it is difficult to debug and understand why the plugin doesn't work. So, to help you, I created this "to-do" list, to make a proper calling for help. Please read it before post something in Q&A!

Before posting

• Check if your bug is in already answered in Q&A or in the issue section.
• Test your configuration using the button or the command palette. If there are some errors, the plugin will inform you want to cause this!
• Check if your organization/connection allow you to connect to GitHub.
• Open the console (using CMD+MAJ+I or CTRL+MAJ+I) and check the log. You need to search for log mentioning Github Publisher only. Some error are common :
  • 404 : The API of GitHub doesn't found your repository or the branch you linked. Please re-check and validate your settings.
  • 301 : The repository was moved
  • 403 : The action is forbidden
  • 409 (branch merging) : there is a merge conflict, use GitHub to merge the two. It happens a lot when you «spam» the same file.

Common limitation of the plugin

Before posting to get help, here some limitation I can't do anything :

• The plugin can't send to multiple repo when using the multiple file share. If you have a lot of file that must be sent in another repo, use another vault.
• The plugin can't clean when used with fixed folder
• The plugin will clean up the repo if you change any option that change the name creation, folder, …
• The plugin can take a lot of time to send a lot of file (beware of big vault). Please use the share one file when you can.

My repository is exploded

If you fail, you can revert the merging branch using GitHub : Here is a tutorial

If you can't revert, or if the revert doesn't work, you need to manually do it. First, check the PR number that explode your repo. You can get it using the Pull Requests menu, or checking the folder that have been edited by this PR.
After, you need to create a branch :

1. In GitHub, click on Commit :
   
2. You will get a list of commit. Search for the commit with the name [Publisher] Merging #{PR number - 1} for example, #625 if it's the #626 PR.
3. Click on View commit details :
   
   4. Click on the browse file button
   5. Click on the commit number and type the branch name, for example, revert :
   
   6. Now, you need to open : A local terminal console (if you have git installed) or a codespace (if you have any) for this repository. Don't forget to git pull if you have already cloned the repository.
   7. You need to be on your main branch, so first : git checkout main ; After, you have to run git checkout revert <path to edited file or folder>. If you want to take an entire folder, for example docs, just type docs/.. It will take all file
   8. git commit -am "restoring folder" && git push. If you use VScode, you can also use the menu to ordering your file restoration.

How to get help

So, if you can't found any solution to your problem, here is a form you have to fill when posting :

- Command used : 
	- [ ] SHARE ON FILE
	- [ ] SHARE ALL SHARED FILE
	- [ ] Update the repository with new file only
	- [ ] Update the repository with edited file only
	- [ ] Update the repository with edited and new file
	- [ ] Clean the repository
- My plugin data : <put the file here. Don't forget to remove/clean your Github Token>
- The file I try to send : <file>; if multiple, leave it blank
- [ ] I already checked my repository and it's valid 
- [ ] My repository exists (link to the repo : ) but the plugin doesn't find it. 
- [ ] I already tried to send an example file to the repo 
<!--- example file 
---
share: true
title: Somethings
---
contents
-->
- Screenshot to the log : (open it using CTRL+MAJ+I)
- Other relevant screenshot : 

It is possible you get a real bug, so the discussion can be turned into an issue!