Set up nbdev in repo

[doyu]

https://github.com/Origami-TinyML/tflm_hello_world/blob/main/README.md#sprint-1

You can find all instruction from https://nbdev.fast.ai/

[doyu]

JFYI, https://github.com/Origami-TinyML/tflm_hello_world/issues/8#issuecomment-1403744979

[lifeofborna]

Me and Nella were working on initializing the nbdev GitHub repo, but we encountered an issue with the nbdev_new/any nbdev command which caused a JSONDecodeError . We managed to resolve this issue by downloading the main repository as a zip file and running nbdev_new on it. This solution worked on both of our PCs and all of the nbdev commands, such as nbdev_preview and nbdev_docs, are now functioning properly. However, we are now facing another problem when trying to make a pull request (PR). The error message states that "Origami-TinyML: main and lifeofborna:master are entirely different commit histories", preventing us from making a PR. Can you please provide guidance on how to move forward? The fork that has the working nbdev can be found at https://github.com/lifeofborna/tflm_hello_world.

[doyu]

If repo history is different, you might mess up some git commits? Youl could apply your changes on the top of new repo, then. This would help, I guess.

I will take a look at your repo tomorrow.

[doyu]

JFYI: I tried to install nbdev and one of actions to deploy on pages failed. To work around this issue, you need to grant write permission of workflow as pointed out here, in case that you haven't found out yet.

https://forums.fast.ai/t/unable-to-create-simple-gh-pages-output-with-nbdev-hello-world/103306/6

Also, you probably need to verify if your changes work on your own fork of the repo at first. Once you verify on your git repo, you would send a PR in Origami repo.

[lifeofborna]

How can I replicate the error "one of the actions to deploy on pages failed" even though I have already the read & write permissions enabled on my fork and no errors are displayed previously in the actions of my repository? (Link to actions: https://github.com/lifeofborna/tflm_hello_world/actions)

Or did you perhaps mean in your own clone of the repo where you tried to install nbdev yourself? :sweat_smile:

[doyu]

Or did you perhaps mean in your own clone of the repo where you tried to install nbdev yourself? 

Yes, that's what I did ;)

[lifeofborna]

Ah okay !

When I get some time freed up I'll try to resolve this issue me and Nella faced upon trying to do a PR:

[doyu]

"Workflow permissions" has RW now. If you change this, R only, git push fails.

[lifeofborna]

"Workflow permissions" has RW now. If you change this, R only, git push fails.

Ah yes, I think the nbdev docs mentioned this change when I initialized nbdev to my fork so I didn't face this issue :+1:

[doyu]

The error message states that "Origami-TinyML: main and lifeofborna:master are entirely different commit histories"

Just adding your changes on the top of a newly cloned clean repo again, it would be OK, I guess.

[doyu]

Ah yes, I think the nbdev docs mentioned this change when I initialized nbdev to my fork so I didn't face this issue +1

Could you please point out where it is mentioned? I completely missed that instruction :P

[doyu]

Ok, now I found but this is in the migration section of nbdev1. This should be in the main section of nbdev(2).

https://nbdev.fast.ai/migrating.html#edit-workflow-permissions

[lifeofborna]

Ok, now I found but this is in the migration section of nbdev1. This should be in the main section of nbdev(2).

https://nbdev.fast.ai/migrating.html#edit-workflow-permissions

Nice but now I'm wondering when you cloned the repo from GitHub directly (git clone command) and ran nbdev_new did you face any problems locally when running nbdev_docs or nbdev_preview? Nella and I got a JSON error when we tried to run those after cloning & nbdev_new and then running those commands.

The only way we could get it to work was to download the "ZIP" file and then run nbdev_new and the rest of the commands.

[doyu]

They work OK for me. Check your nbdev version.

[nellatuulikki]

We set up nbdev in Borne's fork and it seemed to run correctly in terminal for commands nbdev_docs and nbdev_preview when I tested it yesterday. Some files and folders needs to be added to .gitignore.