From 22693c7ba3d1fb9bfa5a02ca274b751646cbe744 Mon Sep 17 00:00:00 2001 From: thomas-bc Date: Fri, 8 Dec 2023 10:19:02 -0800 Subject: [PATCH 1/4] Trigger CI on release/* branches --- .github/workflows/build-test-macos.yml | 5 +++-- .github/workflows/build-test-rpi.yml | 5 +++-- .github/workflows/build-test.yml | 5 +++-- .github/workflows/codeql-jpl-standard.yml | 4 ++-- .github/workflows/codeql-security-scan.yml | 4 ++-- .github/workflows/cppcheck-scan.yml | 4 ++-- .github/workflows/cpplint-scan.yml | 4 ++-- .github/workflows/ext-build-hello-world.yml | 5 +++-- .github/workflows/ext-build-led-blinker.yml | 5 +++-- .github/workflows/ext-build-math-comp.yml | 5 +++-- .github/workflows/ext-raspberry-led-blinker.yml | 5 +++-- .github/workflows/fpp-tests.yml | 5 +++-- .github/workflows/python-format.yml | 4 ++-- 13 files changed, 34 insertions(+), 26 deletions(-) diff --git a/.github/workflows/build-test-macos.yml b/.github/workflows/build-test-macos.yml index 7a216add23..01e5485142 100644 --- a/.github/workflows/build-test-macos.yml +++ b/.github/workflows/build-test-macos.yml @@ -6,9 +6,10 @@ name: macOS-CI # events but only for the master branch on: push: - branches: [ master, devel ] + branches: [ devel, release/* ] pull_request: - branches: [ master, devel ] + # The branches below must be a subset of the branches above + branches: [ devel, release/* ] paths-ignore: - 'docs/**' - '**.md' diff --git a/.github/workflows/build-test-rpi.yml b/.github/workflows/build-test-rpi.yml index bec381345c..d804dac6a9 100644 --- a/.github/workflows/build-test-rpi.yml +++ b/.github/workflows/build-test-rpi.yml @@ -6,9 +6,10 @@ name: RPI-CI # events but only for the master branch on: push: - branches: [ master, devel ] + branches: [ devel, release/* ] pull_request: - branches: [ master, devel ] + # The branches below must be a subset of the branches above + branches: [ devel, release/* ] paths-ignore: - 'docs/**' - '**.md' diff --git a/.github/workflows/build-test.yml b/.github/workflows/build-test.yml index eebcc06df5..574127eef6 100644 --- a/.github/workflows/build-test.yml +++ b/.github/workflows/build-test.yml @@ -6,9 +6,10 @@ name: CI # events but only for the master branch on: push: - branches: [ master, devel ] + branches: [ devel, release/* ] pull_request: - branches: [ master, devel ] + # The branches below must be a subset of the branches above + branches: [ devel, release/* ] paths-ignore: - 'docs/**' - '**.md' diff --git a/.github/workflows/codeql-jpl-standard.yml b/.github/workflows/codeql-jpl-standard.yml index 042ab570f1..3613ccc055 100644 --- a/.github/workflows/codeql-jpl-standard.yml +++ b/.github/workflows/codeql-jpl-standard.yml @@ -5,10 +5,10 @@ name: "JPL Coding Standard Scan" on: push: - branches: [ master, devel ] + branches: [ devel, release/* ] pull_request: # The branches below must be a subset of the branches above - branches: [ master, devel ] + branches: [ devel, release/* ] paths-ignore: - 'docs/**' - '**.md' diff --git a/.github/workflows/codeql-security-scan.yml b/.github/workflows/codeql-security-scan.yml index 90ec1a3b17..0485caea65 100644 --- a/.github/workflows/codeql-security-scan.yml +++ b/.github/workflows/codeql-security-scan.yml @@ -5,10 +5,10 @@ name: "CodeQL Security Scan" on: push: - branches: [ master, devel ] + branches: [ devel, release/* ] pull_request: # The branches below must be a subset of the branches above - branches: [ master, devel ] + branches: [ devel, release/* ] paths-ignore: - 'docs/**' - '**.md' diff --git a/.github/workflows/cppcheck-scan.yml b/.github/workflows/cppcheck-scan.yml index 6d85692f3d..0eacddfdd7 100644 --- a/.github/workflows/cppcheck-scan.yml +++ b/.github/workflows/cppcheck-scan.yml @@ -3,10 +3,10 @@ name: "Cppcheck Scan" on: push: - branches: [ master, devel ] + branches: [ devel, release/* ] pull_request: # The branches below must be a subset of the branches above - branches: [ master, devel ] + branches: [ devel, release/* ] paths-ignore: - 'docs/**' - '**.md' diff --git a/.github/workflows/cpplint-scan.yml b/.github/workflows/cpplint-scan.yml index 7ad7289f4e..a6ee125405 100644 --- a/.github/workflows/cpplint-scan.yml +++ b/.github/workflows/cpplint-scan.yml @@ -2,10 +2,10 @@ name: "Cpplint Scan" on: push: - branches: [master, devel] + branches: [ devel, release/* ] pull_request: # The branches below must be a subset of the branches above - branches: [master, devel ] + branches: [ devel, release/* ] paths-ignore: - 'docs/**' - '**.md' diff --git a/.github/workflows/ext-build-hello-world.yml b/.github/workflows/ext-build-hello-world.yml index a0e6c44821..c665d114f7 100644 --- a/.github/workflows/ext-build-hello-world.yml +++ b/.github/workflows/ext-build-hello-world.yml @@ -4,9 +4,10 @@ name: "Tutorial: HelloWorld" on: push: - branches: [ master, devel ] + branches: [ devel, release/* ] pull_request: - branches: [ master, devel ] + # The branches below must be a subset of the branches above + branches: [ devel, release/* ] paths-ignore: - 'docs/**' - '**.md' diff --git a/.github/workflows/ext-build-led-blinker.yml b/.github/workflows/ext-build-led-blinker.yml index d53b52ee4f..b4b03ffd8e 100644 --- a/.github/workflows/ext-build-led-blinker.yml +++ b/.github/workflows/ext-build-led-blinker.yml @@ -4,9 +4,10 @@ name: "Tutorial: LedBlinker" on: push: - branches: [ master, devel ] + branches: [ devel, release/* ] pull_request: - branches: [ master, devel ] + # The branches below must be a subset of the branches above + branches: [ devel, release/* ] paths-ignore: - 'docs/**' - '**.md' diff --git a/.github/workflows/ext-build-math-comp.yml b/.github/workflows/ext-build-math-comp.yml index c5d34fd57b..511943bc9b 100644 --- a/.github/workflows/ext-build-math-comp.yml +++ b/.github/workflows/ext-build-math-comp.yml @@ -4,9 +4,10 @@ name: "Tutorial: MathComponent" on: push: - branches: [ master, devel ] + branches: [ devel, release/* ] pull_request: - branches: [ master, devel ] + # The branches below must be a subset of the branches above + branches: [ devel, release/* ] paths-ignore: - 'docs/**' - '**.md' diff --git a/.github/workflows/ext-raspberry-led-blinker.yml b/.github/workflows/ext-raspberry-led-blinker.yml index f036515aee..8a1e49a84c 100644 --- a/.github/workflows/ext-raspberry-led-blinker.yml +++ b/.github/workflows/ext-raspberry-led-blinker.yml @@ -5,9 +5,10 @@ name: "RPI LedBlinker" on: push: - branches: [ master, devel ] + branches: [ devel, release/* ] pull_request: - branches: [ master, devel ] + # The branches below must be a subset of the branches above + branches: [ devel, release/* ] paths-ignore: - 'docs/**' - '**.md' diff --git a/.github/workflows/fpp-tests.yml b/.github/workflows/fpp-tests.yml index 565f4eb920..6b41f7a565 100644 --- a/.github/workflows/fpp-tests.yml +++ b/.github/workflows/fpp-tests.yml @@ -2,9 +2,10 @@ name: "FppTest" on: push: - branches: [ master, devel ] + branches: [ devel, release/* ] pull_request: - branches: [ master, devel ] + # The branches below must be a subset of the branches above + branches: [ devel, release/* ] paths-ignore: - 'docs/**' - '**.md' diff --git a/.github/workflows/python-format.yml b/.github/workflows/python-format.yml index 7c4436dab5..47edc56411 100644 --- a/.github/workflows/python-format.yml +++ b/.github/workflows/python-format.yml @@ -2,10 +2,10 @@ name: Format Python on: push: - branches: [master, devel] + branches: [ devel, release/* ] pull_request: # The branches below must be a subset of the branches above - branches: [master, devel] + branches: [ devel, release/* ] jobs: format: From 2d81dd9295916b45b14726cd5508f33cad654fd4 Mon Sep 17 00:00:00 2001 From: thomas-bc Date: Fri, 8 Dec 2023 10:20:19 -0800 Subject: [PATCH 2/4] Rename release/documentation to docs/auto-documentation --- .github/actions/autodoc.bash | 4 ++-- docs/UsersGuide/cmake/cmake-platforms.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/actions/autodoc.bash b/.github/actions/autodoc.bash index e5a496e591..481014a187 100755 --- a/.github/actions/autodoc.bash +++ b/.github/actions/autodoc.bash @@ -8,9 +8,9 @@ cd "$GITHUB_WORKSPACE" REMOTE="${1:-origin}" git config --local user.email "nasa-fprime[bot]@users.noreply.github.com" git config --local user.name "nasa-fprime[bot]" -git fetch "${REMOTE}" release/documentation +git fetch "${REMOTE}" docs/auto-documentation git fetch "${REMOTE}" devel -git checkout release/documentation +git checkout docs/auto-documentation GIT_EDITOR=true git merge "${REMOTE}"/devel ${GITHUB_WORKSPACE}/docs/doxygen/generate_docs.bash git add -Af "${GITHUB_WORKSPACE}/docs" diff --git a/docs/UsersGuide/cmake/cmake-platforms.md b/docs/UsersGuide/cmake/cmake-platforms.md index 54950708cf..15d9e95e52 100644 --- a/docs/UsersGuide/cmake/cmake-platforms.md +++ b/docs/UsersGuide/cmake/cmake-platforms.md @@ -8,5 +8,5 @@ Build flags and other includes can be added in to support different compile-time In order to create a new platform from scratch, the user can copy "platform.cmake.template" and fill it out to generate the new platform file. It will guide the user through the setup of this piece. -To understand the platform template: [Platform Template File](https://github.com/nasa/fprime/blob/release/documentation/docs/UsersGuide/api/cmake/platform/platform-template.md) +To understand the platform template: [Platform Template File](https://github.com/nasa/fprime/blob/docs/auto-documentation/docs/UsersGuide/api/cmake/platform/platform-template.md) To use the template: [fprime Platform Template](https://github.com/nasa/fprime/blob/devel/cmake/platform/platform.cmake.template) From 4e3bfbe1882f2b6e68c75542ce55e61cb4ebd03a Mon Sep 17 00:00:00 2001 From: thomas-bc Date: Fri, 8 Dec 2023 10:21:49 -0800 Subject: [PATCH 3/4] Fix PR template --- .github/pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index c5eba993e3..eb50b59369 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,7 +1,7 @@ | | | |:---|:---| |**_Related Issue(s)_**| | -|**_Has Unit Tests (y/n)_**| || +|**_Has Unit Tests (y/n)_**| | |**_Documentation Included (y/n)_**| | --- From 726e3f0c56254c7d74c0a504c398031966a7ba67 Mon Sep 17 00:00:00 2001 From: thomas-bc Date: Fri, 8 Dec 2023 10:29:50 -0800 Subject: [PATCH 4/4] Glob pattern to release/** --- .github/workflows/build-test-macos.yml | 4 ++-- .github/workflows/build-test-rpi.yml | 4 ++-- .github/workflows/build-test.yml | 4 ++-- .github/workflows/codeql-jpl-standard.yml | 4 ++-- .github/workflows/codeql-security-scan.yml | 4 ++-- .github/workflows/cppcheck-scan.yml | 4 ++-- .github/workflows/cpplint-scan.yml | 4 ++-- .github/workflows/ext-build-hello-world.yml | 4 ++-- .github/workflows/ext-build-led-blinker.yml | 4 ++-- .github/workflows/ext-build-math-comp.yml | 4 ++-- .github/workflows/ext-raspberry-led-blinker.yml | 4 ++-- .github/workflows/fpp-tests.yml | 4 ++-- .github/workflows/python-format.yml | 4 ++-- 13 files changed, 26 insertions(+), 26 deletions(-) diff --git a/.github/workflows/build-test-macos.yml b/.github/workflows/build-test-macos.yml index 01e5485142..d6a754fdee 100644 --- a/.github/workflows/build-test-macos.yml +++ b/.github/workflows/build-test-macos.yml @@ -6,10 +6,10 @@ name: macOS-CI # events but only for the master branch on: push: - branches: [ devel, release/* ] + branches: [ devel, release/** ] pull_request: # The branches below must be a subset of the branches above - branches: [ devel, release/* ] + branches: [ devel, release/** ] paths-ignore: - 'docs/**' - '**.md' diff --git a/.github/workflows/build-test-rpi.yml b/.github/workflows/build-test-rpi.yml index d804dac6a9..7bc8c850f4 100644 --- a/.github/workflows/build-test-rpi.yml +++ b/.github/workflows/build-test-rpi.yml @@ -6,10 +6,10 @@ name: RPI-CI # events but only for the master branch on: push: - branches: [ devel, release/* ] + branches: [ devel, release/** ] pull_request: # The branches below must be a subset of the branches above - branches: [ devel, release/* ] + branches: [ devel, release/** ] paths-ignore: - 'docs/**' - '**.md' diff --git a/.github/workflows/build-test.yml b/.github/workflows/build-test.yml index 574127eef6..db6ac937eb 100644 --- a/.github/workflows/build-test.yml +++ b/.github/workflows/build-test.yml @@ -6,10 +6,10 @@ name: CI # events but only for the master branch on: push: - branches: [ devel, release/* ] + branches: [ devel, release/** ] pull_request: # The branches below must be a subset of the branches above - branches: [ devel, release/* ] + branches: [ devel, release/** ] paths-ignore: - 'docs/**' - '**.md' diff --git a/.github/workflows/codeql-jpl-standard.yml b/.github/workflows/codeql-jpl-standard.yml index 3613ccc055..4694fc454d 100644 --- a/.github/workflows/codeql-jpl-standard.yml +++ b/.github/workflows/codeql-jpl-standard.yml @@ -5,10 +5,10 @@ name: "JPL Coding Standard Scan" on: push: - branches: [ devel, release/* ] + branches: [ devel, release/** ] pull_request: # The branches below must be a subset of the branches above - branches: [ devel, release/* ] + branches: [ devel, release/** ] paths-ignore: - 'docs/**' - '**.md' diff --git a/.github/workflows/codeql-security-scan.yml b/.github/workflows/codeql-security-scan.yml index 0485caea65..6fffcd7803 100644 --- a/.github/workflows/codeql-security-scan.yml +++ b/.github/workflows/codeql-security-scan.yml @@ -5,10 +5,10 @@ name: "CodeQL Security Scan" on: push: - branches: [ devel, release/* ] + branches: [ devel, release/** ] pull_request: # The branches below must be a subset of the branches above - branches: [ devel, release/* ] + branches: [ devel, release/** ] paths-ignore: - 'docs/**' - '**.md' diff --git a/.github/workflows/cppcheck-scan.yml b/.github/workflows/cppcheck-scan.yml index 0eacddfdd7..1d4c18384e 100644 --- a/.github/workflows/cppcheck-scan.yml +++ b/.github/workflows/cppcheck-scan.yml @@ -3,10 +3,10 @@ name: "Cppcheck Scan" on: push: - branches: [ devel, release/* ] + branches: [ devel, release/** ] pull_request: # The branches below must be a subset of the branches above - branches: [ devel, release/* ] + branches: [ devel, release/** ] paths-ignore: - 'docs/**' - '**.md' diff --git a/.github/workflows/cpplint-scan.yml b/.github/workflows/cpplint-scan.yml index a6ee125405..d18a80b2cd 100644 --- a/.github/workflows/cpplint-scan.yml +++ b/.github/workflows/cpplint-scan.yml @@ -2,10 +2,10 @@ name: "Cpplint Scan" on: push: - branches: [ devel, release/* ] + branches: [ devel, release/** ] pull_request: # The branches below must be a subset of the branches above - branches: [ devel, release/* ] + branches: [ devel, release/** ] paths-ignore: - 'docs/**' - '**.md' diff --git a/.github/workflows/ext-build-hello-world.yml b/.github/workflows/ext-build-hello-world.yml index c665d114f7..219d70f2c7 100644 --- a/.github/workflows/ext-build-hello-world.yml +++ b/.github/workflows/ext-build-hello-world.yml @@ -4,10 +4,10 @@ name: "Tutorial: HelloWorld" on: push: - branches: [ devel, release/* ] + branches: [ devel, release/** ] pull_request: # The branches below must be a subset of the branches above - branches: [ devel, release/* ] + branches: [ devel, release/** ] paths-ignore: - 'docs/**' - '**.md' diff --git a/.github/workflows/ext-build-led-blinker.yml b/.github/workflows/ext-build-led-blinker.yml index b4b03ffd8e..929595fd83 100644 --- a/.github/workflows/ext-build-led-blinker.yml +++ b/.github/workflows/ext-build-led-blinker.yml @@ -4,10 +4,10 @@ name: "Tutorial: LedBlinker" on: push: - branches: [ devel, release/* ] + branches: [ devel, release/** ] pull_request: # The branches below must be a subset of the branches above - branches: [ devel, release/* ] + branches: [ devel, release/** ] paths-ignore: - 'docs/**' - '**.md' diff --git a/.github/workflows/ext-build-math-comp.yml b/.github/workflows/ext-build-math-comp.yml index 511943bc9b..2c4520460c 100644 --- a/.github/workflows/ext-build-math-comp.yml +++ b/.github/workflows/ext-build-math-comp.yml @@ -4,10 +4,10 @@ name: "Tutorial: MathComponent" on: push: - branches: [ devel, release/* ] + branches: [ devel, release/** ] pull_request: # The branches below must be a subset of the branches above - branches: [ devel, release/* ] + branches: [ devel, release/** ] paths-ignore: - 'docs/**' - '**.md' diff --git a/.github/workflows/ext-raspberry-led-blinker.yml b/.github/workflows/ext-raspberry-led-blinker.yml index 8a1e49a84c..28de393026 100644 --- a/.github/workflows/ext-raspberry-led-blinker.yml +++ b/.github/workflows/ext-raspberry-led-blinker.yml @@ -5,10 +5,10 @@ name: "RPI LedBlinker" on: push: - branches: [ devel, release/* ] + branches: [ devel, release/** ] pull_request: # The branches below must be a subset of the branches above - branches: [ devel, release/* ] + branches: [ devel, release/** ] paths-ignore: - 'docs/**' - '**.md' diff --git a/.github/workflows/fpp-tests.yml b/.github/workflows/fpp-tests.yml index 6b41f7a565..0a95f43fbf 100644 --- a/.github/workflows/fpp-tests.yml +++ b/.github/workflows/fpp-tests.yml @@ -2,10 +2,10 @@ name: "FppTest" on: push: - branches: [ devel, release/* ] + branches: [ devel, release/** ] pull_request: # The branches below must be a subset of the branches above - branches: [ devel, release/* ] + branches: [ devel, release/** ] paths-ignore: - 'docs/**' - '**.md' diff --git a/.github/workflows/python-format.yml b/.github/workflows/python-format.yml index 47edc56411..581b2c4320 100644 --- a/.github/workflows/python-format.yml +++ b/.github/workflows/python-format.yml @@ -2,10 +2,10 @@ name: Format Python on: push: - branches: [ devel, release/* ] + branches: [ devel, release/** ] pull_request: # The branches below must be a subset of the branches above - branches: [ devel, release/* ] + branches: [ devel, release/** ] jobs: format: