You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/RELEASE_PROCESS.MD
+7-7
Original file line number
Diff line number
Diff line change
@@ -17,20 +17,20 @@ The purpose of this document is to document the release process for future refer
17
17
## Upload zip file, and update JSON for Arduino
18
18
9. Download the repo at the tag created above `git clone --recursive -b <tagname> https://github.com/sparkfun/Arduino_Apollo3`. Tip: If you forget to include --recursive in the clone, all submodules can be acquired via `git submodule update --init --recursive`.
19
19
10. Make sure this directory is named "Arduino_Apollo3"
20
-
10. Create a tarball of the release. `tar --exclude-vcs -zcvf Arduino_Apollo3.tar.gz Arduino_Apollo3`. Make sure to include `--exclude-vcs` to exclude gigabytes of git information from the release package.
20
+
11. Create a tarball of the release. `tar --exclude-vcs -zcvf Arduino_Apollo3.tar.gz Arduino_Apollo3`. Make sure to include `--exclude-vcs` to exclude gigabytes of git information from the release package.
21
21
WARNING: Do not do this on a windows machine, or unix users will need to run a chmod -x on the file later.
22
-
13. Edit the release created above, and upload the tarball
23
-
14. Run a SHA256 chksum on the tarball, and note size. `shasum -a 256 Arduino_Apollo3.tar.gz`
24
-
15. Update the [JSON File](https://github.com/sparkfun/Arduino_Apollo3/blob/main/package_sparkfun_apollo3_index.json) with new information. This can be quickly done from the github website ("." to open vscode).
22
+
12. Edit the release created above, and upload the tarball
23
+
13. Run a SHA256 chksum on the tarball, and note size. `shasum -a 256 Arduino_Apollo3.tar.gz`
24
+
14. Update the [JSON File](https://github.com/sparkfun/Arduino_Apollo3/blob/main/package_sparkfun_apollo3_index.json) with new information. This can be quickly done from the github website ("." to open vscode).
25
25
* Create a new entry, or copy a previous one.
26
26
* Update the version number
27
27
* Update the URL of the tarball
28
28
* Update the checksum with the SHA256 of the tarball
29
29
* Update the size of the poackage
30
30
31
31
## Verification and Clean-up
32
-
16. After updating the json file, restart your arduino IDE (that has the JSON added in the additional board manager preference). The new release should now appear. If not, check for any error messages from arduino about parsing the JSON, and check to make sure no errors were made or steps skipped in the section above.
33
-
17. Download and verify the release.
34
-
18. (Optional) To reduce possible merge conflicts later, perform a pull request from "main" branch into the "dev" branch so that both have all changes from these steps.
32
+
15. After updating the json file, restart your arduino IDE (that has the JSON added in the additional board manager preference). The new release should now appear. If not, check for any error messages from arduino about parsing the JSON, and check to make sure no errors were made or steps skipped in the section above.
33
+
16. Download and verify the release.
34
+
17. (Optional) To reduce possible merge conflicts later, perform a pull request from "main" branch into the "dev" branch so that both have all changes from these steps.
0 commit comments