Skip to content

Commit 5fb9b50

Browse files
authored
CI-CD Updates (#768)
* Use new version of CI-CD Actions * Use cSpell spell check, and use ubuntu-20.04 for formatting check * Format and spell check all files in the portable directory * Remove the https:// from #errors and #warnings as uncrustify attempts to change it to /* * Use checkout@v3 instead of checkout@v2 on all jobs ---------
1 parent d6bccb1 commit 5fb9b50

File tree

485 files changed

+112534
-111325
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

485 files changed

+112534
-111325
lines changed

Diff for: .github/.cSpellWords.txt

+918
Large diffs are not rendered by default.

Diff for: .github/lexicon.txt

-3,165
This file was deleted.

Diff for: .github/pull_request_process.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Pull Request Process
22

3-
This document explains the stages that a Pull Request (PR) goes through when a pull request is submitted to a git repository in the FreeRTOS organization in Github. Before you start a PR, please read and familiarize yourself with [CONTRIBUTING.md](.github/CONTRIBUTING.md)
3+
This document explains the stages that a Pull Request (PR) goes through when a pull request is submitted to a git repository in the FreeRTOS organization in Github. Before you start a PR, please read and familiarize yourself with [CONTRIBUTING.md](CONTRIBUTING.md)
44

55
## ****Terminologies****
66

Diff for: .github/scripts/kernel_checker.py

+6-2
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,8 @@
3636
KERNEL_IGNORED_FILES = [
3737
'FreeRTOS-openocd.c',
3838
'Makefile',
39-
'.DS_Store'
39+
'.DS_Store',
40+
'cspell.config.yaml'
4041
]
4142

4243
KERNEL_IGNORED_EXTENSIONS = [
@@ -88,7 +89,10 @@
8889
r'.*portable/IAR/AtmelSAM7S64/.*AT91SAM7.*',
8990
r'.*portable/GCC/ARM7_AT91SAM7S/.*',
9091
r'.*portable/MPLAB/PIC18F/stdio.h',
91-
r'.*portable/ThirdParty/xClang/XCOREAI/*'
92+
r'.*portable/ThirdParty/xClang/XCOREAI/*',
93+
r'.*IAR/ARM_C*',
94+
r'.*IAR/78K0R/*',
95+
r'.*CCS/MSP430X/*'
9296
]
9397

9498
KERNEL_THIRD_PARTY_PATTERNS = [

Diff for: .github/workflows/auto-release.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -31,14 +31,14 @@ jobs:
3131

3232
# Currently FreeRTOS/.github/scripts houses the release script. Download it for upcoming usage
3333
- name: Checkout FreeRTOS Release Tools
34-
uses: actions/checkout@v2
34+
uses: actions/checkout@v3
3535
with:
3636
repository: FreeRTOS/FreeRTOS
3737
path: tools
3838

3939
# Simpler git auth if we use checkout action and forward the repo to release script
4040
- name: Checkout FreeRTOS Kernel
41-
uses: actions/checkout@v2
41+
uses: actions/checkout@v3
4242
with:
4343
path: local_kernel
4444
fetch-depth: 0

Diff for: .github/workflows/ci.yml

+39-61
Original file line numberDiff line numberDiff line change
@@ -6,75 +6,53 @@ on:
66
branches: [main]
77
workflow_dispatch:
88
jobs:
9+
formatting:
10+
runs-on: ubuntu-20.04
11+
steps:
12+
- uses: actions/checkout@v3
13+
- name: Check Formatting of FreeRTOS-Kernel Files
14+
uses: FreeRTOS/CI-CD-Github-Actions/formatting@main
15+
916
spell-check:
17+
runs-on: ubuntu-latest
18+
steps:
19+
- name: Clone This Repo
20+
uses: actions/checkout@v3
21+
- name: Run spellings check
22+
uses: FreeRTOS/CI-CD-Github-Actions/spellings@main
23+
with:
24+
path: ./
25+
exclude-files: History.txt
26+
27+
link-verifier:
1028
runs-on: ubuntu-latest
1129
steps:
12-
- name: Checkout Parent Repo
13-
uses: actions/checkout@v2
14-
with:
15-
ref: main
16-
repository: aws/aws-iot-device-sdk-embedded-C
17-
path: main
1830
- name: Clone This Repo
19-
uses: actions/checkout@v2
20-
with:
21-
path: ./kernel
22-
- name: Install spell
23-
run: |
24-
sudo apt-get install spell
25-
sudo apt-get install util-linux
26-
- name: Check spelling
27-
run: |
28-
PATH=$PATH:main/tools/spell
29-
# Make sure that the portable directory is not included in the spellcheck.
30-
sed -i 's/find $DIRNAME/find $DIRNAME -not -path '*portable*'/g' main/tools/spell/find-unknown-comment-words
31-
find-unknown-comment-words --directory kernel/ --lexicon ./kernel/.github/lexicon.txt
32-
if [ "$?" = "0" ]; then
33-
exit 0
34-
else
35-
exit 1
36-
fi
37-
formatting:
38-
runs-on: ubuntu-20.04
39-
steps:
40-
- uses: actions/checkout@v2
41-
- name: Install Uncrustify
42-
run: sudo apt-get install uncrustify=0.69.0+dfsg1-1build1
43-
- name: Run Uncrustify
44-
run: |
45-
uncrustify --version
46-
find . portable/MemMang/* portable/Common/* \( -name portable \) -prune -false -o -iname "*.[hc]" -exec uncrustify --check -c .github/uncrustify.cfg {} +
47-
- name: Check For Trailing Whitespace
48-
run: |
49-
set +e
50-
grep --exclude="*.md" --exclude-dir=".git" -rnI -e "[[:blank:]]$" .
51-
if [ "$?" = "0" ]; then
52-
echo "Files have trailing whitespace."
53-
exit 1
54-
else
55-
exit 0
56-
fi
57-
shell: bash
58-
- name: Check for CRLF
59-
working-directory: ${{ inputs.path }}
60-
run: |
61-
set +e
62-
find . -path ./.git -prune -o -exec file {} + | grep "CRLF"
63-
if [ "$?" = "0" ]; then
64-
echo "Files have CRLF line endings."
65-
exit 1
66-
else
67-
exit 0
68-
fi
69-
shell: bash
31+
uses: actions/checkout@v3
32+
- name: Link Verification
33+
uses: FreeRTOS/CI-CD-Github-Actions/link-verifier@v2
7034

7135
url-check:
7236
runs-on: ubuntu-latest
7337
steps:
74-
- name: Clone This Repo
75-
uses: actions/checkout@v2
38+
- uses: actions/checkout@v3
7639
with:
77-
path: ./kernel
40+
path: ./kernel
41+
7842
- name: URL Checker
7943
run: |
80-
bash kernel/.github/actions/url_verifier.sh kernel
44+
bash kernel/.github/actions/url_verifier.sh kernel
45+
46+
verify-manifest:
47+
runs-on: ubuntu-latest
48+
steps:
49+
- uses: actions/checkout@v3
50+
with:
51+
submodules: true
52+
fetch-depth: 0
53+
54+
- name: Run manifest verifier
55+
uses: FreeRTOS/CI-CD-GitHub-Actions/manifest-verifier@main
56+
with:
57+
path: ./
58+
fail-on-incorrect-version: true

Diff for: .github/workflows/git-secrets.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ jobs:
77
git-secrets:
88
runs-on: ubuntu-latest
99
steps:
10-
- uses: actions/checkout@v2
10+
- uses: actions/checkout@v3
1111
with:
1212
submodules: recursive
1313
- name: Checkout awslabs/git-secrets
14-
uses: actions/checkout@v2
14+
uses: actions/checkout@v3
1515
with:
1616
repository: awslabs/git-secrets
1717
ref: master

Diff for: .github/workflows/kernel-checks.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,15 @@ jobs:
1818

1919
# There is shared code, hosted by FreeRTOS/FreeRTOS, with deps needed by header checker
2020
- name: Checkout FreeRTOS Tools
21-
uses: actions/checkout@v2
21+
uses: actions/checkout@v3
2222
with:
2323
repository: FreeRTOS/FreeRTOS
2424
ref: main
2525
path: tools
2626

2727
# Checkout user pull request changes
2828
- name: Checkout Pull Request
29-
uses: actions/checkout@v2
29+
uses: actions/checkout@v3
3030
with:
3131
path: inspect
3232

Diff for: .github/workflows/kernel-demos.yml

+10-10
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ jobs:
77
runs-on: windows-latest
88
steps:
99
- name: Checkout the FreeRTOS/FreeRTOS Repository
10-
uses: actions/checkout@v2
10+
uses: actions/checkout@v3
1111
with:
1212
ref: main
1313
repository: FreeRTOS/FreeRTOS
@@ -16,7 +16,7 @@ jobs:
1616

1717
# Checkout user pull request changes
1818
- name: Checkout Pull Request
19-
uses: actions/checkout@v2
19+
uses: actions/checkout@v3
2020
with:
2121
path: ./FreeRTOS/Source
2222

@@ -36,7 +36,7 @@ jobs:
3636
runs-on: windows-latest
3737
steps:
3838
- name: Checkout the FreeRTOS/FreeRTOS Repository
39-
uses: actions/checkout@v2
39+
uses: actions/checkout@v3
4040
with:
4141
ref: main
4242
repository: FreeRTOS/FreeRTOS
@@ -45,7 +45,7 @@ jobs:
4545

4646
# Checkout user pull request changes
4747
- name: Checkout Pull Request
48-
uses: actions/checkout@v2
48+
uses: actions/checkout@v3
4949
with:
5050
path: ./FreeRTOS/Source
5151

@@ -61,7 +61,7 @@ jobs:
6161
runs-on: ubuntu-latest
6262
steps:
6363
- name: Checkout the FreeRTOS/FreeRTOS Repository
64-
uses: actions/checkout@v2
64+
uses: actions/checkout@v3
6565
with:
6666
ref: main
6767
repository: FreeRTOS/FreeRTOS
@@ -70,7 +70,7 @@ jobs:
7070

7171
# Checkout user pull request changes
7272
- name: Checkout Pull Request
73-
uses: actions/checkout@v2
73+
uses: actions/checkout@v3
7474
with:
7575
path: ./FreeRTOS/Source
7676

@@ -95,7 +95,7 @@ jobs:
9595
runs-on: ubuntu-latest
9696
steps:
9797
- name: Checkout the FreeRTOS/FreeRTOS Repository
98-
uses: actions/checkout@v2
98+
uses: actions/checkout@v3
9999
with:
100100
ref: main
101101
repository: FreeRTOS/FreeRTOS
@@ -104,7 +104,7 @@ jobs:
104104

105105
# Checkout user pull request changes
106106
- name: Checkout Pull Request
107-
uses: actions/checkout@v2
107+
uses: actions/checkout@v3
108108
with:
109109
path: ./FreeRTOS/Source
110110

@@ -124,7 +124,7 @@ jobs:
124124
runs-on: ubuntu-latest
125125
steps:
126126
- name: Checkout the FreeRTOS/FreeRTOS Repository
127-
uses: actions/checkout@v2
127+
uses: actions/checkout@v3
128128
with:
129129
ref: main
130130
repository: FreeRTOS/FreeRTOS
@@ -146,7 +146,7 @@ jobs:
146146
147147
# Checkout user pull request changes
148148
- name: Checkout Pull Request
149-
uses: actions/checkout@v2
149+
uses: actions/checkout@v3
150150
with:
151151
path: ./FreeRTOS/Source
152152

Diff for: .github/workflows/unit-tests.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ jobs:
66
runs-on: ubuntu-20.04
77
steps:
88
- name: Checkout Parent Repository
9-
uses: actions/checkout@v2
9+
uses: actions/checkout@v3
1010
with:
1111
ref: main
1212
repository: FreeRTOS/FreeRTOS
@@ -15,7 +15,7 @@ jobs:
1515

1616
# Checkout user pull request changes
1717
- name: Checkout Pull Request
18-
uses: actions/checkout@v2
18+
uses: actions/checkout@v3
1919
with:
2020
path: ./FreeRTOS/Source
2121

Diff for: CMakeLists.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ cmake_minimum_required(VERSION 3.15)
44
# FREERTOS_PORT, if not specified and native port detected, uses the native compile.
55
#
66
# User is responsible for one library target:
7-
# freertos_config ,typcially an INTERFACE library
7+
# freertos_config ,typically an INTERFACE library
88
#
99
# DEPRECATED: FREERTOS_CONFIG_FILE_DIRECTORY - but still supported if no freertos_config defined for now.
1010
# May be removed at some point in the future.

0 commit comments

Comments
 (0)