Skip to content

Commit

Permalink
new(ci): added github pages around rules overview file.
Browse files Browse the repository at this point in the history
Signed-off-by: Federico Di Pierro <nierro92@gmail.com>
  • Loading branch information
FedeDP authored and poiana committed Jul 26, 2023
1 parent 8ea38c8 commit eff6915
Show file tree
Hide file tree
Showing 4 changed files with 49 additions and 259 deletions.
41 changes: 41 additions & 0 deletions .github/workflows/pages.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: Deploy Github Pages
on:
push:
branches: [main]

permissions:
contents: read
pages: write
id-token: write

concurrency:
group: "pages"
cancel-in-progress: true

jobs:
deploy-pages:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3

- uses: actions/setup-python@v2
with:
python-version: 3.x

- name: Generate inventory
run: |
python rules_inventory/scripts/rules_overview_generator.py --rules_file=rules/falco_rules.yaml > docs/overview.md
- run: pip install -r requirements.txt

- run: mkdocs build

- uses: actions/upload-pages-artifact@v1
with:
path: 'site'

- id: deployment
uses: actions/deploy-pages@v1
6 changes: 6 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
site_name: Falcosecurity Rules
site_url: https://github.com/falcosecurity/rules
nav:
- Home: overview.md

theme: material
2 changes: 2 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
mkdocs
mkdocs-material
Loading

0 comments on commit eff6915

Please sign in to comment.