rusefi
/
custom-board-bundle-sample-fork-of-rusefi
mirror of https://github.com/rusefi/custom-board-bundle-sample-fork-of-rusefi.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Improve Jenkins set-up documentation (#1603)

This commit is contained in:
David Holdeman 2020-07-13 13:16:39 -05:00 committed by GitHub
parent deb43f98db
commit ca885d2a3b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 58 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

99
misc/jenkins/setup/readme.md
View File

@ -1,27 +1,68 @@
# Jenkins setup
https://git-scm.com/downloads
### Install Cygwin
https://cygwin.com/install.html
https://sliksvn.com/download/ used to produce numeric revision number needs to be added to System PATH manually
Cygwin packages that need to be installed:
- make
- gcc-core
- mingw64-i686-gcc-core
- mingw64-i686-gcc-g++
- mingw64-x86_64-gcc-core
- mingw64-x86_64-gcc-g++
- python3
- git
- subversion
- doxygen
- zip
- ncftp
- wget
- ccache
- graphviz
https://cygwin.com/install.html needs to be added to System PATH manually
### Install Java JDK 8
https://www.oracle.com/java/technologies/javase/javase-jdk8-downloads.html
cygwin: make, gcc, zip, wget
cygwin: ccache
Add System Environment Variable
CCACHE_DIR
c:\ccache
java needs to be added to System PATH manually
https://ant.apache.org/ needs to be added to System PATH manually. used to build java stuff
### Install Ant:
https://ant.apache.org/
### Install Jenkins
https://jenkins.io/download/
Additional plugings:
### Install Kicad
http://www.kicad-pcb.org/download/
for iBom automation
Pipeline GitHub Notify Step
### Install for Hardware Testing
#### ST Link Utility
http://www.st.com/st-web-ui/static/active/en/st_prod_software_internet/resource/technical/software/utility/stsw-link004.zip
#### ST Virtual Serial Driver
http://www.st.com/web/en/catalog/tools/PF257938
### System Environment Variables:
|Variable|Example|
|--|--|
|CCACHE_DIR|C:\ccache |
|ANT_HOME|C:\Program Files\apache-ant-1.10.8|
|JAVA_HOME|C:\Program Files\Java\jdk1.8.0_251|
|RUSEFI_FTP_SERVER|ftp.yourdomain.com|
|RUSEFI_BUILD_FTP_USER|rusefi_firmware|
|RUSEFI_BUILD_FTP_PASS|secretpass|
|RUSEFI_DOXYGEN_FTP_USER|rusefi_doxygen|
|RUSEFI_DOXYGEN_FTP_PASS|secretpass|
### Add to Path:
|Tool|Example|
|--|--|
|Java|C:\Program Files (x86)\Common Files\Oracle\Java\javapath|
|Java|%JAVA_HOME%\bin|
|Ant|%ANT_HOME%\bin|
|Cygwin|C:\cygwin64\bin|
|GCC|C:\Program Files (x86)\GNU Arm Embedded Toolchain\9 2020-q2-update\bin|
### Additional Jenkins set-up
#### Additional plugins:
- Pipeline GitHub Notify Step
https://stackoverflow.com/questions/14274293/show-current-state-of-jenkins-build-on-github-repo
@ -33,33 +74,9 @@ smtphost: smtp.gmail.com
r***@gmail.com
useSsl=yes
https://www.ncftp.com/download/ !!! c:\windows !!! needs to be added to System PATH manually. This FTP client installs itself right into c:\windows folder
RUSEFI_BUILD_FTP_USER & RUSEFI_BUILD_FTP_PASS needs to be added to System PATH manually
RUSEFI_DOXYGEN_FTP_USER & RUSEFI_DOXYGEN_FTP_PASS needs to be added to System PATH manually
http://www.doxygen.nl/download.html needs to be added to System PATH manually
https://graphviz.gitlab.io/download/ needs to be added to System PATH manually, used by Doxygen
http://www.kicad-pcb.org/download/ for iBom automation
http://www.st.com/st-web-ui/static/active/en/st_prod_software_internet/resource/technical/software/utility/stsw-link004.zip ST Link Utility
http://www.st.com/web/en/catalog/tools/PF257938 ST virtual serial driver
Jobs:
### Jobs:
1) unit_tests
2) integration_and_primary_bundle
3) documentation
4) build_extra_bundles
5) git2svn_sync
RUSEFI_SVN_PASSWORD needs to be added to System PATH manually