Fix build, move to pnpm & ci update

This commit is contained in:
Sacha Weatherstone 2022-03-09 23:10:04 +11:00
parent 57913a2564
commit 5b27a1cf87
No known key found for this signature in database
GPG key ID: 7AB2D7E206124B31
11 changed files with 8387 additions and 7801 deletions

View file

@ -22,7 +22,7 @@ jobs:
- name: Install protoc-gen-doc
run: go get -u github.com/pseudomuto/protoc-gen-doc/cmd/protoc-gen-doc
- name: Checkout code
uses: actions/checkout@v2
uses: actions/checkout@v3
with:
submodules: true
- name: Generate protobuf docs

View file

@ -6,11 +6,20 @@ jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v3
with:
submodules: true
- uses: actions/setup-node@v2-beta
- uses: pnpm/action-setup@v2.2.1
with:
node-version: 16
- run: yarn install
- run: yarn run build
version: latest
- uses: actions/setup-node@v3
with:
node-version: 17
cache: 'pnpm'
- uses: actions/setup-node@v2
with:
node-version: '16'
cache: 'pnpm'
- run: pnpm install
- run: pnpm format
- run: pnpm build

View file

@ -1,5 +1,5 @@
---
id: build-env
id: build
title: Creating a build environment
sidebar_label: Building Meshtastic
---

View file

@ -48,7 +48,7 @@ A number of [key services](http://github.com/meshtastic/meshtastic-device/tree/m
The easiest way to get started is:
- [Build and install](/docs/developers/firmware/build-env) the standard codebase from GitHub.
- [Build and install](/docs/developers/firmware/build) the standard codebase from GitHub.
- Copy [src/modules/ReplyModule.\*](http://github.com/meshtastic/meshtastic-device/tree/master/src/modules/ReplyModule.cpp) into src/modules/YourModule.*. Then change the port number from *PortNum_REPLY_APP* to *PortNum_PRIVATE_APP\*.
- Edit moduless/Moduless.cpp:setupModules() to add a call to create an instance of your module (see comment at head of that function)
- Rebuild with your new messaging goodness and install on the device

View file

@ -1,21 +1,20 @@
---
id: build-env
title: Creating a build environment
sidebar_label: Building Meshtastic
id: stacktrace-decode
title: Decoding Stacktraces
sidebar_label: Decoding Stacktraces
---
You may encounter a situation where your device crashes and are left with a stacktrace, below are two methods of decoding them.
## Manual
First save the backtrace string to a text file:
:::info
This method uses the symbols of the `firmware.elf` file generated from your latest build, you may wish to rebuild to get up-to-date symbols.
:::
```title="backtrace.txt"
[...]
First save the backtrace string to a text file:
```text title="backtrace.txt"
Backtrace: 0x....
```

View file

@ -6,7 +6,7 @@ sidebar_label: Software Design
This is a mini design doc for developing the meshtastic software.
- [Build instructions](/docs/developers/firmware/build-env)
- [Build instructions](/docs/developers/firmware/build)
- [On device module API](/docs/developers/firmware/module-api) - a tutorial on how to write small modules which run on the device and can message other nodes.
- Our [project board](https://github.com/orgs/meshtastic/projects/1) - shows what things we are currently working on and remaining work items for the current release.
- [Power Management](power.md)

View file

@ -53,7 +53,7 @@ Requires: [Python](https://www.python.org) and [esptool.py](https://github.com/e
### Visual Studio & PlatformIO
There is also the method of using the Visual Studio IDE. This requires having Visual Studio and PlatformIO installed, along with having cloned the meshtastic-device code as per the [build instructions](/docs/developers/firmware/build-env). After loading the project in Visual Studio, select the PlatformIO alien icon, then find the appropriate device, and then click the Erase Flash command.
There is also the method of using the Visual Studio IDE. This requires having Visual Studio and PlatformIO installed, along with having cloned the meshtastic-device code as per the [build instructions](/docs/developers/firmware/build). After loading the project in Visual Studio, select the PlatformIO alien icon, then find the appropriate device, and then click the Erase Flash command.
![Erasing the flash using PlatformIO in Visual Studio Code](/img/platformio-erase.png)

View file

@ -15,6 +15,7 @@
"@algolia/client-search": "^4.12.2",
"@docusaurus/core": "^2.0.0-beta.17",
"@docusaurus/preset-classic": "^2.0.0-beta.17",
"@mdx-js/react": "^1.6.22",
"dotenv": "^16.0.0",
"react": "^17.0.2",
"react-dom": "^17.0.2",
@ -22,18 +23,6 @@
"swr": "^1.2.2",
"url-search-params-polyfill": "^8.1.1"
},
"browserslist": {
"production": [
">0.5%",
"not dead",
"not op_mini all"
],
"development": [
"last 1 chrome version",
"last 1 firefox version",
"last 1 safari version"
]
},
"devDependencies": {
"@docusaurus/module-type-aliases": "^2.0.0-beta.17",
"@tsconfig/docusaurus": "^1.0.4",

8357
pnpm-lock.yaml Normal file

File diff suppressed because it is too large Load diff

View file

@ -223,7 +223,7 @@ module.exports = {
],
},
Contribute: {
"Contribute to Meshtastic": [
"Developers": [
"developers/overview",
{
Protobufs: ["developers/protobufs/api"],
@ -232,7 +232,8 @@ module.exports = {
"developers/publish",
{
Firmware: [
"developers/firmware/build-env",
"developers/firmware/build",
"developers/firmware/stacktrace-decode",
"developers/firmware/device-api",
"developers/firmware/radio-settings",
"developers/firmware/mesh-alg",
@ -276,6 +277,7 @@ module.exports = {
{ type: "ref", id: "hardware/overview" },
{ type: "ref", id: "software/overview" },
{ type: "ref", id: "legal/overview" },
{ type: "ref", id: "developers/overview" },
],
},
Legal: {

7770
yarn.lock

File diff suppressed because it is too large Load diff