Move the freshly generated autodocs to the desired directory and add them to the gh-pages branch:.Git branch | grep -q "gh-pages" & git branch -D gh-pages Create a fresh empty branch named gh-pages (the exact branch name is important!):.To generate and publish the C++ class documentation for the libyui base library in my fork, I did: plus of course the directory hierarchy where the index.html or index.md file is. Put an index.html or an index.md file to a directory, commit it to that branch, and you'll get a page on the project's GitHub page. GitHub pages use a special branch named gh-pages. If the process for building the autodocs is already in place (as is the case for libyui), it is just a matter of generating them, moving them to the right place, and deploying them to the project's GitHub Pages. This can be done once for each GitHub user, for each GitHub organization, GitHub offers hosting documentation on GitHub Pages. This page was last edited on: 15 June 2021Ĭopyright © 2001-2022 German Aerospace Center (DLR) and others.Doxygen-Generated Autodocs on GitHub Pages General Idea While there are common steps useful for most (if not all) projects' CI test workflows in the example above, note that it includes some Veins-specific steps, which need to be adapted to your project's needs. To summarize, the basic structure of the workflow consists of the top-level code blocks name, on, and jobs, defining the workflow's name, trigger(s), and job(s), respectively.Ī CI test job for your project should then typically follow these steps: 1. Src/veins/examples/veins/veins_launchd.log /bin/veins_launchd -vv -daemon -L veins_launchd.log configure WITH_TKENV=no WITH_QTENV=no WITH_OSG=no WITH_OSGEARTH=no Python -c "import sumo print('SUMO_HOME=' + sumo.SUMO_HOME)" > $GITHUB_ENVĮcho "PATH=$PWD/src/omnetpp/bin:$SUMO_HOME/bin:$PATH" > $GITHUB_ENV Python -m pip install -index-url eclipse-sumo If: matrix.sumo_build != 'nightly' # only run this step if the condition is trueĮcho "SUMO_HOME=/usr/share/sumo" > $GITHUB_ENV Sudo apt-get install build-essential gcc g++ bison flex perl python3 libxml2-dev zlib1g-dev default-jre doxygen graphviz Ref: omnetpp-$" = "ppa" ]] then sudo add-apt-repository ppa:sumo/stable fi With: # set values for the predefined action's parameters Uses: # predefined and reusable action for this step (see ) Steps: # define this job's individual steps Matrix: # define variation parameters and their values Runs-on: ubuntu-latest # VM type to run this job onĮnv: # define environment variables for this jobįail-fast: false # do not cancel all in-progress jobs if any job variation fails On: # define triggers on which to run this workflow In the following, we will go through an example workflow (from the Veins project), commenting on the code (for a complete GitHub Actions guide, see the official documentation): name: linux-build # workflow name as stated under your project's GitHub 'Actions' tab One popular way to perform CI tests is to create a GitHub Actions workflow.Ī GitHub Actions workflow is defined by a YAML file in your GitHub master/main branch, under directory. Since we cannot possibly test integration with all projects out there that depend on SUMO, this document shall assist you in setting up CI tests for your project. While striving to keep backwards compatibility, breaking changes for your project might still be introduced. If you have a project that depends on SUMO, maintaining compatibility with newer SUMO versions can pose an issue. How To create a CI Test with GitHub Actions
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |