Skip to content

Commit 53b693f

Browse files
committed
add github action
1 parent ee09ea6 commit 53b693f

File tree

3 files changed

+58
-9
lines changed

3 files changed

+58
-9
lines changed

.github/workflows/build-deploy.yaml

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: Build & deploy
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
pull_request:
8+
branches:
9+
- master
10+
11+
jobs:
12+
build:
13+
name: Build
14+
runs-on: ubuntu-latest
15+
16+
steps:
17+
- name: Checkout code
18+
uses: actions/checkout@v4
19+
20+
- name: Build site
21+
uses: addnab/docker-run-action@v3
22+
with:
23+
image: spotify/techdocs:v1.2.4
24+
options: -v ${{ github.workspace }}:/src -w /src
25+
run: |
26+
mkdocs build
27+
28+
- name: Upload production-ready build files
29+
uses: actions/upload-artifact@v4
30+
with:
31+
name: site-files
32+
path: ./site
33+
34+
deploy:
35+
name: Deploy
36+
needs: build
37+
runs-on: ubuntu-latest
38+
if: github.ref == 'refs/heads/master'
39+
40+
steps:
41+
- name: Download artifact
42+
uses: actions/download-artifact@v4
43+
with:
44+
name: site-files
45+
path: ./site
46+
47+
- name: Deploy to gh-pages
48+
uses: peaceiris/actions-gh-pages@v4
49+
with:
50+
github_token: ${{ secrets.GITHUB_TOKEN }}
51+
publish_dir: ./site

README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@ Writeups for Down Under CTF 2024.
99

1010
### Content
1111

12-
* Shufflebox
13-
* ./solve/shufflebox/index.md
12+
Github pages: https://sukolenvo.github.io/2024duCTF/
1413

15-
### Technology
14+
I've recently been researching what is available on the market among documentation tools.
1615

17-
I've recently researching what is on the market currently available among documentation tools.
16+
[TechDocs](https://backstage.io/docs/features/techdocs/) caught my eye. This repository is a practical evaluation of the tool.
1817

19-
[TechDocs](https://backstage.io/docs/features/techdocs/) caught my eye. This repository is a practical examination of the tool.
18+
Live preview: `techdocs-cli serve`.
19+
Launching first time can take few minutes to pull necessary docker images, run `techdocs-cli serve -v` to track boot steps.
2020

21-
Live preview: `techdocs-cli serve`. Launching first time can take few minutes to pull necessary docker
22-
images, run `techdocs-cli serve -v` to track boot progress.
21+
Build site:
22+
`techdocs-cli generate`

solve/shufflebox/index.md

-2
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,6 @@ CTF Event: Down Under CTF 2024
1111

1212
Website: [https://downunderctf.com/](https://downunderctf.com/)
1313

14-
Challenge: **shufflebox**
15-
1614
Solves: 582
1715

1816
!!! quote "Description"

0 commit comments

Comments
 (0)