BusKill
add 3d-print docs
create file based on storage.rst to start working on 3d printed buskill installation instructions
The build error - but per our chat I believe we can ignore it for now?
On Wed, Aug 7, 2024 at 12:24 AM Michael Altfield @.***> wrote:
@goldfishlaser https://github.com/goldfishlaser what do you want me to check-on?
— Reply to this email directly, view it on GitHub https://github.com/BusKill/buskill-app/pull/90#issuecomment-2272591072, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAER7EBPP3EUVXFBYCUDLX3ZQGOPXAVCNFSM6AAAAABMDP77HCVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDENZSGU4TCMBXGI . You are receiving this because you were mentioned.Message ID: @.***>
The build error - but per our chat I believe we can ignore it for now?
Yes, please see
- https://tech.michaelaltfield.net/2021/11/22/bidi-unicode-github-defense/
- https://github.com/maltfield/detect-malicious-unicode/issues/3
I think I've fixed the (malicious) unicode checker workflow. I think it was an issue with new github actions permissions and also the new safe.directory git config that was breaking the diff. For more info, see:
- https://github.com/maltfield/detect-malicious-unicode/issues/3
- https://github.com/BusKill/buskill-app/commit/ece61e3ef84e53d072c3076e9f6e2993e92e506d
I also added some better error codes and some better ways to trigger it to re-run. One thing that'll cause it to re-run is by unlocking a PR, so I'm going to toggle that to force it to re-run on this PR.
looks like I can't trigger it on my end because it can't find Melanie's commit, which causes the diff to fail.
@goldfishlaser can you please push a trivial commit (just a newline or something) to see if the unicode_warn workflow works?
See also Fix "fatal: bad object" Error
- https://github.com/maltfield/detect-malicious-unicode/issues/4
![github-actions[bot] avatar](https://avatars.githubusercontent.com/in/15368?v=4 "Published by a pub.dev verified publisher"){kind=small}
Update: Still working on fixing the unicode warning CI script. Good news is that I at least got better error reporting working; it left a comment above saying that the diff failed. Progress..
ok, I fixed the unicode workflow. And, actually, it found some non-ascii text in your PR
- https://github.com/BusKill/buskill-app/actions/runs/10309604160/job/28539589911
2024-08-08T21:13:32.8764352Z + unicode_diff=$'\357\273\277'
2024-08-08T21:13:32.8764454Z + unicode_grep_exit_code=0
2024-08-08T21:13:32.8764569Z + echo $'\357\273\277'
2024-08-08T21:13:32.8764696Z ++ echo -n $'\357\273\277'
2024-08-08T21:13:32.8764773Z ++ hd
2024-08-08T21:13:32.8765100Z + unicode_diff_hexdump='00000000 ef bb bf |...|
2024-08-08T21:13:32.8765183Z 00000003'
2024-08-08T21:13:32.8765291Z + '[' 0 -ne 0 ']'
2024-08-08T21:13:32.8765539Z + echo '00000000 ef bb bf |...|
2024-08-08T21:13:32.8765626Z 00000003'
2024-08-08T21:13:32.8765802Z + [[ 00000000 ef bb bf |...|
2024-08-08T21:13:32.8765907Z 00000003 == '' ]]
2024-08-08T21:13:32.8766148Z + human_result='^^ WARNING: Unicode characters found in diff!'
It's the first 3 bytes of the file (0xef, 0xbb, and 0xbf).
00000000 ef bb bf 2e 2e 20 5f 75 73 62 5f 73 74 6f 72 61 |..... _usb_stora|
I thought that maybe this was output from diff, but it is in-fact present in the file. Note that the file "appears" to start with with two dots and a space .. , but it actually has these three bytes before that
user@disp6631:~/Downloads/sandbox/buskill-app$ cat docs/hardware_dev/3d-print.rst | head
.. _usb_storage_initialization:
Build a 3D-Printed BusKill Instructions
=================================
This section will describe how format the USB storage drive and put the BusKill software on it.
.. note::
The BusKill software cannot run on the USB drive. It must be run from your computer.
user@disp6631:~/Downloads/sandbox/buskill-app$
user@disp6631:~/Downloads/sandbox/buskill-app$ cat docs/hardware_dev/3d-print.rst | hd | head
00000000 ef bb bf 2e 2e 20 5f 75 73 62 5f 73 74 6f 72 61 |..... _usb_stora|
00000010 67 65 5f 69 6e 69 74 69 61 6c 69 7a 61 74 69 6f |ge_initializatio|
00000020 6e 3a 0a 0a 42 75 69 6c 64 20 61 20 33 44 2d 50 |n:..Build a 3D-P|
00000030 72 69 6e 74 65 64 20 42 75 73 4b 69 6c 6c 20 49 |rinted BusKill I|
00000040 6e 73 74 72 75 63 74 69 6f 6e 73 0a 3d 3d 3d 3d |nstructions.====|
00000050 3d 3d 3d 3d 3d 3d 3d 3d 3d 3d 3d 3d 3d 3d 3d 3d |================|
00000060 3d 3d 3d 3d 3d 3d 3d 3d 3d 3d 3d 3d 3d 0a 0a 54 |=============..T|
00000070 68 69 73 20 73 65 63 74 69 6f 6e 20 77 69 6c 6c |his section will|
00000080 20 64 65 73 63 72 69 62 65 20 68 6f 77 20 66 6f | describe how fo|
00000090 72 6d 61 74 20 74 68 65 20 55 53 42 20 73 74 6f |rmat the USB sto|
user@disp6631:~/Downloads/sandbox/buskill-app$
Please remove this from the file.
Update: oh, I think it's this
- https://en.wikipedia.org/wiki/Byte_order_mark#UTF-8
goldfishlaser@goldfishlaser-Inspiron-17-7779:~/Repos/buskill-app$ cat docs/hardware_dev/3d-print.rst | hd | head 00000000 48 65 61 64 65 72 20 31 0a 3d 3d 3d 3d 3d 3d 3d |Header 1.=======| 00000010 3d 0a 2d 2d 2d 2d 2d 2d 2d 2d 0a 53 75 62 74 69 |=.--------.Subti| 00000020 74 6c 65 0a 2d 2d 2d 2d 2d 2d 2d 2d 0a 0a 45 78 |tle.--------..Ex| 00000030 61 6d 70 6c 65 20 74 65 78 74 2e 0a 0a |ample text...| 0000003d
Is there unicode here?
INFO: No unicode characters found in PR's commits
@goldfishlaser to be clear, this is a good message saying that there isn't any (problematic) unicode.
You seemed to have solved the issue at some point above.
Oh really? I am a little confused as there did still seem to be a build error during the malicious unicode checks run?
In order to prevent my progress from being halted, I ended up making my own docs site, but I'm happy to try PRing again soon if its gonna work.
On Wed, Apr 9, 2025, 12:32 Michael Altfield @.***> wrote:
INFO: No unicode characters found in PR's commits
@goldfishlaser https://github.com/goldfishlaser to be clear, this is a good message saying that there isn't any (problematic) unicode.
You seemed to have solved the issue at some point above.
— Reply to this email directly, view it on GitHub https://github.com/BusKill/buskill-app/pull/90#issuecomment-2790335118, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAER7EAFJBA6BVETULVNV3D2YVDTNAVCNFSM6AAAAAB2XVX3JWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDOOJQGMZTKMJRHA . You are receiving this because you were mentioned.Message ID: @.***> maltfield left a comment (BusKill/buskill-app#90) https://github.com/BusKill/buskill-app/pull/90#issuecomment-2790335118
INFO: No unicode characters found in PR's commits
@goldfishlaser https://github.com/goldfishlaser to be clear, this is a good message saying that there isn't any (problematic) unicode.
You seemed to have solved the issue at some point above.
— Reply to this email directly, view it on GitHub https://github.com/BusKill/buskill-app/pull/90#issuecomment-2790335118, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAER7EAFJBA6BVETULVNV3D2YVDTNAVCNFSM6AAAAAB2XVX3JWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDOOJQGMZTKMJRHA . You are receiving this because you were mentioned.Message ID: @.***>