From 4f7d9ed5163429adc3b79194b302463369083d8a Mon Sep 17 00:00:00 2001 From: ZanzyTHEbar Date: Wed, 18 Jan 2023 18:05:21 +0000 Subject: [PATCH] feat: setting up ci/cd for docs --- .../workflows/build_release_vitepress.yml.txt | 0 vitepress/.releaserc | 173 ++++++++++++++++++ .../pages/firmware_guide/upload_firmware.md | 2 +- 3 files changed, 174 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/build_release_vitepress.yml.txt create mode 100644 vitepress/.releaserc diff --git a/.github/workflows/build_release_vitepress.yml.txt b/.github/workflows/build_release_vitepress.yml.txt new file mode 100644 index 0000000..e69de29 diff --git a/vitepress/.releaserc b/vitepress/.releaserc new file mode 100644 index 0000000..279bd51 --- /dev/null +++ b/vitepress/.releaserc @@ -0,0 +1,173 @@ +{ + "branches": [ + "main", + "master" + ], + "plugins": [ + [ + "@semantic-release/commit-analyzer", + { + "preset": "conventionalcommits", + "parserOpts": { + "noteKeywords": [ + "BREAKING CHANGE", + "BREAKING CHANGES", + "BREAKING" + ] + }, + "releaseRules": [ + { + "breaking": true, + "release": "major" + }, + { + "type": "feat", + "release": "minor" + }, + { + "type": "fix", + "release": "patch" + }, + { + "type": "perf", + "release": "patch" + }, + { + "type": "revert", + "release": "patch" + }, + { + "type": "docs", + "release": "minor" + }, + { + "type": "style", + "release": "patch" + }, + { + "type": "refactor", + "release": "patch" + }, + { + "type": "test", + "release": "patch" + }, + { + "type": "build", + "release": "patch" + }, + { + "type": "ci", + "scope": "ci-*", + "release": "patch" + }, + { + "type": "chore", + "release": false + }, + { + "type": "no-release", + "release": false + } + ] + } + ], + [ + "@semantic-release/release-notes-generator", + { + "preset": "conventionalcommits", + "parserOpts": { + "noteKeywords": [ + "BREAKING CHANGE", + "BREAKING CHANGES", + "BREAKING" + ] + }, + "writerOpts": { + "commitsSort": [ + "subject", + "scope" + ] + }, + "presetConfig": { + "types": [ + { + "type": "feat", + "section": "🍕 Features" + }, + { + "type": "feature", + "section": "🍕 Features" + }, + { + "type": "fix", + "section": "🐛 Bug Fixes" + }, + { + "type": "perf", + "section": "🔥 Performance Improvements" + }, + { + "type": "revert", + "section": "⏩ Reverts" + }, + { + "type": "docs", + "section": "📝 Documentation" + }, + { + "type": "style", + "section": "🎨 Styles" + }, + { + "type": "refactor", + "section": "🧑‍💻 Code Refactoring" + }, + { + "type": "test", + "section": "✅ Tests" + }, + { + "type": "build", + "section": "🤖 Build System" + }, + { + "type": "ci", + "section": "🔁 Continuous Integration" + } + ] + } + } + ], + [ + "@semantic-release/changelog", + { + "changelogTitle": "# 📦 Changelog \n[![conventional commits](https://img.shields.io/badge/conventional%20commits-1.0.0-yellow.svg)](https://conventionalcommits.org)\n[![semantic versioning](https://img.shields.io/badge/semantic%20versioning-2.0.0-green.svg)](https://semver.org)\n> All notable changes to this project will be documented in this file" + } + ], + [ + "@semantic-release/exec", + { + "prepareCmd": "sed -i 's/\"version\": \"[0-9\\.]*\",/\"version\": \"${nextRelease.version}\",/g' ./NetworkManager/library.json", + "publishCmd": "pio pkg publish --no-interactive" + } + ], + [ + "@semantic-release/github", + { + "addReleases": "bottom" + } + ], + [ + "@semantic-release/git", + { + "assets": [ + "NetworkManager/library.json", + "LICENSE*", + "CHANGELOG.md" + ], + "message": "chore(${nextRelease.type}): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}" + } + ] + ] +} \ No newline at end of file diff --git a/vitepress/docs/src/pages/firmware_guide/upload_firmware.md b/vitepress/docs/src/pages/firmware_guide/upload_firmware.md index 7541be9..fb529f4 100644 --- a/vitepress/docs/src/pages/firmware_guide/upload_firmware.md +++ b/vitepress/docs/src/pages/firmware_guide/upload_firmware.md @@ -91,7 +91,7 @@ Keep in mind while testing and getting set up, the ESP can only have one client, ## Troubleshooting -If you encountered an issue while following these steps check the [FAQ.](/misc/faq/) +If you encountered an issue while following these steps check the [FAQ.](/misc/faq.html) If you don't find an answer to your question there ask in **#questions** channel in [the discord](https://discord.gg/kkXYbVykZX), we will be happy to help.