Docs: Automatically build / update decompile line count on documentation site (#650)

* prep work for next step

* better formatting on latest updates

* test

* fix mistakes
This commit is contained in:
Tyler Wilding
2021-06-29 20:31:35 -04:00
committed by GitHub
parent 1af0f4a1a7
commit a6c8065957
5 changed files with 68 additions and 9 deletions
+42
View File
@@ -0,0 +1,42 @@
name: Re-build Doc Site
# Controls when the action will run. Triggers the workflow on push or pull request
# events but only for the master branch
on:
push:
branches:
- master
paths:
- 'goal_src/**'
- 'docs/gh-pages-proj/**'
jobs:
lint:
name: Update Documentation Site
runs-on: ubuntu-20.04
# Set some sort of timeout in the event of run-away builds. We are limited on concurrent jobs so, get rid of them.
timeout-minutes: 10
steps:
- name: Checkout Repository
uses: actions/checkout@v2
# just do a sed for now
- name: Update Line Count
run: |
chmod +x ./.github/workflows/scripts/line-count.sh
./.github/workflows/scripts/line-count.sh
- name: Update Site
run: |
cd docs/gh-pages-proj
npm install
npm run build
cd ../..
cp -r ./docs/gh-pages-proj/dist/* ./docs/
- name: Add & Commit
uses: EndBug/add-and-commit@v7.2.1
with:
default_author: github_actions
pull_strategy: "NO-PULL"
message: "Updated github pages site"
+5
View File
@@ -0,0 +1,5 @@
#!/bin/bash
LINE_COUNT=$(find ./goal_src -name '*.gc' | xargs wc -l | tail -1 | awk -F'[^0-9]+' '{ print $2 }')
sed -i "s/.*value.*/ \"value\": ${LINE_COUNT},/g" ./docs/gh-pages-proj/src/config/progress.json
@@ -0,0 +1,8 @@
{
"jak1": {
"locPercentage": {
"value": 5.5,
"label": "Lines of Code"
}
}
}
+2 -6
View File
@@ -1,7 +1,3 @@
const projectProgress = {
jak1: {
decomp: 5
}
}
const projectProgress = require('./config/progress.json')
export default projectProgress
export default projectProgress
+11 -3
View File
@@ -62,7 +62,9 @@
buffer-value="0"
:value="jak1BlackLabelStatus.decompDone"
stream
height="25"
>
{{jak1BlackLabelStatus.decompLabel}} - {{jak1BlackLabelStatus.decompDone}}%
</v-progress-linear>
</v-col>
</v-row>
@@ -86,7 +88,7 @@
{{ pr.user.login }}
</p>
<div class="text--primary">
{{ pr.body }}
<pre class="wrapped-pre">{{ pr.body }}</pre>
</div>
</v-card-text>
<v-card-actions>
@@ -110,6 +112,11 @@
background-size: cover;
min-height: 50vh;
}
.wrapped-pre {
word-wrap: normal;
white-space: pre-wrap;
font-family: "Roboto", sans-serif !important;
}
</style>
<script>
@@ -122,7 +129,8 @@ export default {
return {
recentPRs: [],
jak1BlackLabelStatus: {
decompDone: projectProgress.jak1.decomp
decompDone: (projectProgress.jak1.locPercentage.value / 750000.0) * 100.0,
decompLabel: projectProgress.jak1.locPercentage.label
}
};
},
@@ -141,7 +149,7 @@ export default {
`https://api.github.com/search/issues?q=repo:water111/jak-project+is:pr+is:merged&sort=updated`
);
const data = await response.json();
const numPRs = 6;
const numPRs = 9;
for (var i = 0; i < numPRs; i++) {
var pr = data.items[i];
if (pr.body.length == 0) {