-
Notifications
You must be signed in to change notification settings - Fork 136
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1222 from bluebandit21/addition/CI_generating_doc…
…umentation Add in CI workflow for generating and deploying documentation to github.io site
- Loading branch information
Showing
8 changed files
with
200 additions
and
67 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| #!/bin/bash | ||
|
|
||
| # Install Etterna requirements | ||
| sudo apt-get install build-essential libssl-dev libx11-dev libxrandr-dev libcurl4-openssl-dev libglu1-mesa-dev libpulse-dev libogg-dev libasound-dev libjack-dev | ||
|
|
||
| #Install doxygen | ||
| sudo apt-get install doxygen | ||
|
|
||
| eval "$(luarocks path --bin)" | ||
|
|
||
| # Generate Etterna CMake | ||
| mkdir build && cd build | ||
| cmake -G "Unix Makefiles" -DWITH_CRASHPAD=OFF .. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| #!/bin/bash | ||
|
|
||
| mkdir lua_tmp && cd lua_tmp | ||
|
|
||
| # Install various requirements | ||
| sudo apt install build-essential libreadline-dev unzip | ||
|
|
||
| # Acquire and install Lua | ||
| curl -R -O http://www.lua.org/ftp/lua-5.1.5.tar.gz | ||
| tar -zxf lua-5.1.5.tar.gz | ||
| cd lua-5.1.5 | ||
| make linux | ||
| sudo make install | ||
| cd .. | ||
|
|
||
| # Acquire and install LuaRocks | ||
| wget https://luarocks.org/releases/luarocks-3.9.1.tar.gz | ||
| tar zxpf luarocks-3.9.1.tar.gz | ||
| cd luarocks-3.9.1 | ||
| ./configure && make | ||
| sudo make install | ||
|
|
||
| # Install ldoc | ||
| luarocks install --local ldoc |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| # Workflow for building and deploying Etterna documentation | ||
| name: Etterna documentation CI | ||
|
|
||
| on: | ||
| # Runs on pushes to develop | ||
| push: | ||
| branches: ["develop"] | ||
|
|
||
| # Allows you to run this workflow manually from the Actions tab | ||
| workflow_dispatch: | ||
|
|
||
| # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | ||
| permissions: | ||
| contents: read | ||
| pages: write | ||
| id-token: write | ||
|
|
||
| # Allow one concurrent deployment | ||
| concurrency: | ||
| group: "pages" | ||
| cancel-in-progress: true | ||
|
|
||
| jobs: | ||
| #Build job | ||
| build: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| # Setup | ||
| - name: Checkout | ||
| uses: actions/checkout@v3 | ||
| - name: Update apt | ||
| run: "sudo apt-get update" | ||
| - name: Install Ldoc | ||
| run: "bash ./.ci/install_ldoc.sh" | ||
| - name: Generate LDoc/Doxygen configs | ||
| run: "bash ./.ci/generate_doc_configs.sh" | ||
| #Jekyll build | ||
| - name: Setup Pages | ||
| uses: actions/configure-pages@v2 | ||
| - name: Build with Jekyll | ||
| uses: actions/jekyll-build-pages@v1 | ||
| with: | ||
| source: ./Docs/ | ||
| destination: ./_site | ||
| #Ldoc build | ||
| - name: Run LDoc | ||
| run: | | ||
| cd build | ||
| make ldoc | ||
| sudo mv ldoc_output ../_site/ldoc | ||
| #Doxygen build | ||
| - name: Run Doxygen | ||
| run: | | ||
| cd build | ||
| make doxygen | ||
| sudo mv doxygen ../_site | ||
| - name: Upload artifact | ||
| uses: actions/upload-pages-artifact@v1 | ||
|
|
||
| # Deployment job | ||
| deploy: | ||
| environment: | ||
| name: github-pages | ||
| url: ${{ steps.deployment.outputs.page_url }} | ||
| runs-on: ubuntu-latest | ||
| needs: build | ||
| steps: | ||
| - name: Deploy to GitHub Pages | ||
| id: deployment | ||
| uses: actions/deploy-pages@v1 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.