Use CI-CD-Github-Actions for spelling and formatting, add in the bot formatting action, update the CI-CD workflow files. Fix incorrect spelling and formatting on files. (#1083)

* Use new version of CI-CD Actions, checkout@v3 instead of checkout@v2 on all jobs * Use cSpell spell check, and use ubuntu-20.04 for formatting check * Add in bot formatting action * Update freertos_demo.yml and freertos_plus_demo.yml files to increase github log readability * Add in a Qemu demo onto the workflows.
2025-10-14 08:47:45 -04:00 · 2023-09-06 15:35:37 -04:00 · 2023-09-06 15:35:37 -04:00 · 3a2f6646f0
commit 3a2f6646f0
parent 537007d96c
1036 changed files with 134568 additions and 127281 deletions
--- a/.github/scripts/common/header_checker.py
+++ b/.github/scripts/common/header_checker.py
@ -1,7 +1,7 @@
 #!/usr/bin/env python3
 # /*
 # * FreeRTOS V202212.00
-# * Copyright (C) 2021 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
+# * Copyright (C) 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 # *
 # * Permission is hereby granted, free of charge, to any person obtaining a copy of
 # * this software and associated documentation files (the "Software"), to deal in
--- a/.github/scripts/common/requirements.txt
+++ b/.github/scripts/common/requirements.txt
@ -1,14 +1,14 @@
-certifi==2023.7.22
-chardet==4.0.0
+Deprecated
+GitPython
+PyGithub
+PyJWT
+PyYAML
+certifi
+chardet
 colorama
-Deprecated==1.2.10
-gitdb==4.0.5
-GitPython==3.1.32
-idna==2.10
-PyGithub==1.55
-PyJWT==2.4.0
-PyYAML==5.4
+gitdb
+idna
 requests
-smmap==3.0.4
-urllib3==1.26.5
-wrapt==1.12.1
+smmap
+urllib3
+wrapt
--- a/.github/scripts/core_checker.py
+++ b/.github/scripts/core_checker.py
@ -119,6 +119,7 @@ FREERTOS_IGNORED_EXTENSIONS = [
    '.ipcf',
    '.ise',
    '.jlink',
+    '.js',
    '.json',
    '.la',
    '.launch',
@ -172,6 +173,7 @@ FREERTOS_IGNORED_EXTENSIONS = [
    '.pl',
    '.plg',
    '.png',
+    '.props',
    '.prc',
    '.pref',
    '.prefs',
@ -216,6 +218,7 @@ FREERTOS_IGNORED_EXTENSIONS = [
    '.tags',
    '.tcl',
    '.tdt',
+    '.templ',
    '.template',
    '.tgt',
    '.tps',
@ -250,14 +253,12 @@ FREERTOS_IGNORED_EXTENSIONS = [
    '.xmsgs',
    '.xsl',
    '.yml',
-    '.md',
    '.zip'
 ]

 FREERTOS_IGNORED_PATTERNS = [
    r'.*\.git.*',
    r'.*mbedtls_config\.h.*',
-    r'.*mbedtls_config\.h.*',
    r'.*CMSIS.*',
    r'.*/Nordic_Code/*',
    r'.*/Nuvoton_Code/*',
@ -275,8 +276,40 @@ FREERTOS_IGNORED_PATTERNS = [
    r'.*/trcKernelPortSnapshotConfig\.h.*',
    r'.*/MicroZed_hw_platform.*',
    r'.*/ThirdParty/.*',
-    r'FreeRTOS\-Plus/Demo/Common/WinPCap/.*',
-    r'FreeRTOS\-Plus/Source/FreeRTOS-Plus-Trace/.*',
+    r'.*/WinPCap/.*',
+    r'.*/DRIVERS/.*',
+    r'.*/FreeRTOS-Plus-Trace/.*',
+    r'.*/Reliance-Edge/.*',
+    r'.*/HCS12_CodeWarrior_banked/.*',
+    r'.*/ARM7_STR75x_GCC/.*',
+    r'.*/ARM7_STR75x_IAR/.*',
+    r'.*/lwip-1.4.0/.*',
+    r'.*/lwip-1.1.0/.*',
+    r'.*/MSP430X_MSP430F5438_CCS/.*',
+    r'.*/Atmel/.*',
+    r'.*/drivers/.*',
+    r'.*/lwIP/.*',
+    r'.*/ARM7_AT91FR40008_GCC/.*',
+    r'.*/ARM7_AT91SAM7S64_IAR/.*',
+    r'.*/ARM7_LPC2106_GCC/.*',
+    r'.*/CORTEX_A9_Cyclone_V_SoC_DK/.*',
+    r'.*/CORTEX_A9_Zynq_ZC702/.*',
+    r'.*/FreeRTOS-Plus/Demo/FreeRTOS_Plus_Reliance_Edge_and_CLI_Windows_Simulator/ConfigurationFiles//.*',
+    r'.*/ARM7_AT91FR40008_GCC/.*',
+    r'.*/ARM7_STR71x_IAR/.*',
+    r'FreeRTOS/Demo/HCS12_GCC_banked/.*',
+    r'FreeRTOS/Demo/CORTEX_LM3S102_GCC/hw_include/.*',
+    r'FreeRTOS/Demo/CORTEX_LM3S102_GCC/hw_include/.*',
+    r'FreeRTOS/Demo/CORTEX_STM32L152_Discovery_IAR/include/.*',
+    r'FreeRTOS/Demo/CORTEX_M0_Infineon_XMC1000_IAR_Keil_GCC/.*',
+    r'FreeRTOS/Demo/CORTEX_M4F_Infineon_XMC4000_Keil/.*',
+    r'FreeRTOS/Demo/AVR_ATMega4809_Atmel_Studio/RTOSDemo/.*',
+    r'FreeRTOS/Demo/AVR32_UC3/.*',
+    r'FreeRTOS/Demo/ARM7_STR75x_GCC/STLibrary/inc/.*',
+    r'FreeRTOS/Demo/ARM7_STR75x_IAR/STLibrary/inc/.*',
+    r'FreeRTOS/Demo/CORTEX_R4F_RZ_T_GCC_IAR/System/GCC/inc/.*',
+    r'FreeRTOS/Demo/CORTEX_A5_SAMA5D2x_Xplained_IAR/AtmelFiles/drivers/misc/.*',
+    r'FreeRTOS/Demo/CORTEX_ATSAM3X_Atmel_Studio/src/.*',
    r'FreeRTOS-Plus/Demo/FreeRTOS_Plus_CLI_with_Trace_Windows_Simulator/Trace_Recorder_Configuration/.*',
    r'FreeRTOS-Plus/Demo/FreeRTOS_Plus_TCP_IPv6_Demo/common/WinPCap/.*',
    r'FreeRTOS-Plus/Demo/FreeRTOS_Plus_TCP_IPv6_Demo/common/WinPCap/pcap/.*',
@ -291,6 +324,7 @@ FREERTOS_IGNORED_PATTERNS = [
 ]

 FREERTOS_IGNORED_FILES = [
+    'cspell.config.yaml',
    '.cproject',
    '.project',
    'fyi-another-way-to-ignore-file.txt',
@ -310,12 +344,28 @@ FREERTOS_IGNORED_FILES = [
    'reg_test.S',
    'gdbinit',
    'libslirp-version.h',
+    'LPC21xx.h',
+    'lpc221x.h',
+    'winbase.h',
+    'windows.h',
+    'direct.h',
+    'stm32f10x_conf.h',
+    'lwipopts.h',
+    'lwipopts.h',
+    'xil_assert.h',
+    'alt_i2c.h',
+    'alt_clkmgr.h',
+    'hal_lcd.c',
+    'adc.h',
+    'redconf.c',
+    'redconf.h',
+    'redtypes.h',
 ]

 FREERTOS_HEADER = [
    '/*\n',
    ' * FreeRTOS V202212.00\n',
-    ' * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.\n',
+    ' * Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.\n',
    ' *\n',
    ' * Permission is hereby granted, free of charge, to any person obtaining a copy of\n',
    ' * this software and associated documentation files (the "Software"), to deal in\n',
@ -340,7 +390,7 @@ FREERTOS_HEADER = [
    ' */\n',
 ]

-FREERTOS_COPYRIGHT_REGEX = r"^( *(\/\*|\*|#|\/\/))? Copyright \(C\) 20\d\d Amazon.com, Inc. or its affiliates.  All Rights Reserved\.( \*\/)?$"
+FREERTOS_COPYRIGHT_REGEX = r"^( *(\/\*|\*|#|\/\/))? Copyright \(C\) 20\d\d Amazon.com, Inc. or its affiliates. All Rights Reserved\.( \*\/)?$"

 def main():
    parser = HeaderChecker.configArgParser()
--- a/.github/scripts/qemu_reader.c
+++ b/.github/scripts/qemu_reader.c
@ -0,0 +1,38 @@
+#include <stdio.h>
+#include <stdlib.h>
+
+int main( int argc, char * argv[] )
+{
+    setvbuf( stdout, NULL, _IONBF, 0 );
+    FILE * fp;
+    char path[ 256 ];
+    char cmd[ 256 ];
+
+    /* Open the command for reading. */
+    fp = popen("find . -name RTOSDemo.out", "r");
+        /* Read the output a line at a time - output it. */
+    while( fgets( path, sizeof( path ), fp ) != NULL )
+    {
+        printf( "Path: %s\n", path );
+    }
+
+    sprintf(cmd, "qemu-system-arm -machine mps2-an385 -monitor null -semihosting --semihosting-config enable=on,target=native -serial stdio -nographic -kernel %s", path);
+    printf("cmd= %s\n", cmd);
+    fp = popen( cmd, "r" );
+    if( fp == NULL )
+    {
+        printf( "Failed to run command\n" );
+        exit( 1 );
+    }
+
+    /* Read the output a line at a time - output it. */
+    while( fgets( path, sizeof( path ), fp ) != NULL )
+    {
+        printf( "%s", path );
+    }
+
+    /* close */
+    pclose( fp );
+
+    return 0;
+}
--- a/.github/scripts/release-requirements.txt
+++ b/.github/scripts/release-requirements.txt
@ -1,13 +1,14 @@
-certifi>=2020.12.5
-chardet>=3.0.4
-Deprecated>=1.2.10
-gitdb>=4.0.5
-GitPython>=3.1.11
-idna>=2.10
-PyGithub>=1.54
-PyJWT>=1.7.1
-PyYAML>=5.3.1
-requests>=2.24.0
-smmap>=3.0.4
-urllib3>=1.25.11
-wrapt>=1.12.1
+Deprecated
+GitPython
+PyGithub
+PyJWT
+PyYAML
+certifi
+chardet
+colorama
+gitdb
+idna
+requests
+smmap
+urllib3
+wrapt