Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add landing page and rules website #2310

Merged
merged 38 commits into from
Aug 22, 2024
Merged
Show file tree
Hide file tree
Changes from 24 commits
Commits
Show all changes
38 commits
Select commit Hold shift + click to select a range
d8f073b
web: index: add gif of capa running
williballenthin Aug 12, 2024
12232c1
index: add screencast of running capa
williballenthin Aug 12, 2024
b98f133
web: index: start to sketch out style
williballenthin Aug 12, 2024
46b19b2
Merge branch 'master' of github.com:mandiant/capa into wb/webui-actio…
williballenthin Aug 12, 2024
c83545d
Merge branch 'master' of public.github.com:mandiant/capa into wb/webu…
williballenthin Aug 16, 2024
115ee93
web: landing page
williballenthin Aug 16, 2024
53d270a
web: merge rules website
williballenthin Aug 16, 2024
f080a38
web: rules: update bootstrap and integrate rules
williballenthin Aug 16, 2024
033b791
web: rules: use pygments to syntax highlight rules
williballenthin Aug 20, 2024
0feb3ea
web: rules: use capa to load rule content
williballenthin Aug 20, 2024
63efc25
web: rules: linters
williballenthin Aug 20, 2024
e3ccdca
web: rules: add some links to rule page
williballenthin Aug 20, 2024
a2d7f8e
web: rules: accept ?q= parameter for initial search
williballenthin Aug 20, 2024
34ecced
web: rules: add link to namespace search
williballenthin Aug 20, 2024
d3813f9
web: rules: use consistent header
williballenthin Aug 20, 2024
d574c80
web: rules: add umami script
williballenthin Aug 20, 2024
8a1a803
web: add initial whats new section, TODOs
williballenthin Aug 20, 2024
4b94e6d
web: rules: remove old images
williballenthin Aug 20, 2024
741741e
Merge branch 'master' into web-landing-rules
williballenthin Aug 20, 2024
4b900d5
changelog
williballenthin Aug 20, 2024
e52699a
CI: remove temporary branch push event triggers
williballenthin Aug 20, 2024
2fa84ab
Delete web/rules/public/css/bootstrap-4.5.2.min.css
williballenthin Aug 20, 2024
fc6ed2b
Delete web/rules/public/js/bootstrap-4.5.2.min.js
williballenthin Aug 20, 2024
2c98e99
Delete web/public/img/capa.cast
williballenthin Aug 20, 2024
1837427
Rename readme.md to README.md
williballenthin Aug 21, 2024
0d35f0a
web: rules: add scripts to pre-commit configs
williballenthin Aug 21, 2024
e2e116e
Merge branch 'master' into web-landing-rules
williballenthin Aug 21, 2024
b990da2
web: rules: add scripts to pre-commit configs
williballenthin Aug 21, 2024
9d54348
Merge branch 'master' into web-landing-rules
williballenthin Aug 21, 2024
2526983
lints
williballenthin Aug 21, 2024
228de41
ci: add temporary branch push trigger to get incremental builds
williballenthin Aug 21, 2024
07af410
web: rules: assert start_dir must exist
williballenthin Aug 21, 2024
5d585ac
ci: web: rules: deep checkout so we can get rule history
williballenthin Aug 22, 2024
636e6b8
web: rules: check output of subprocess
williballenthin Aug 22, 2024
435ea96
web: rules: factor out common CSS
williballenthin Aug 22, 2024
3c61693
web: rules: fix header links
williballenthin Aug 22, 2024
155ac4c
web: rules: only index rule content, not surrounding text
williballenthin Aug 22, 2024
e57702b
ci: web: remote temporary branch push trigger
williballenthin Aug 22, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 45 additions & 2 deletions .github/workflows/web-deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: deploy web to GitHub Pages

on:
push:
branches: [ master, "wb/webui-actions-1" ]
branches: [ master ]
paths:
- 'web/**'

Expand All @@ -22,6 +22,7 @@ concurrency:

jobs:
build-landing-page:
name: Build landing page
runs-on: ubuntu-latest
steps:
- name: Checkout
Expand All @@ -32,6 +33,7 @@ jobs:
path: './web/public'

build-explorer:
name: Build capa explorer web
runs-on: ubuntu-latest
steps:
- name: Checkout
Expand Down Expand Up @@ -63,12 +65,49 @@ jobs:
name: explorer
path: './web/explorer/dist'

build-rules:
name: Build rules site
runs-on: ubuntu-latest
steps:
- name: Check out the repository
uses: actions/checkout@v4
with:
submodules: 'recursive'
fetch-depth: 1
- name: Set up Python
uses: actions/setup-python@0a5c61591373683505ea898e09a3ea4f39ef2b9c # v5.0.0
with:
python-version: '3.12'
- uses: extractions/setup-just@v2
- name: Install pagefind
uses: supplypike/setup-bin@v4
with:
uri: "https://github.com/CloudCannon/pagefind/releases/download/v1.1.0/pagefind-v1.1.0-x86_64-unknown-linux-musl.tar.gz"
name: "pagefind"
version: "1.1.0"
- name: Install dependencies
working-directory: ./web/rules
run: pip install -r requirements.txt
- name: Build the website
working-directory: ./web/rules
run: just build
- name: Index the website
working-directory: ./web/rules
run: pagefind --site "public"
# upload the build website to artifacts
# so that we can download and inspect, if desired.
- uses: actions/upload-artifact@v4
with:
name: rules
path: './web/rules/public'

deploy:
name: Deploy site to GitHub Pages
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: [build-landing-page, build-explorer]
needs: [build-landing-page, build-explorer, build-rules]
steps:
- uses: actions/download-artifact@v4
with:
Expand All @@ -78,6 +117,10 @@ jobs:
with:
name: explorer
path: './public/explorer'
- uses: actions/download-artifact@v4
with:
name: rules
path: './public/rules'
- name: Setup Pages
uses: actions/configure-pages@v4
- name: Upload artifact
Expand Down
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@

### New Features

- add landing page https://mandiant.github.io/capa/ @williballenthin #2310
- add rules website https://mandiant.github.io/capa/rules @DeeyaSingh #2310

### Breaking Changes

### New Rules (0)
Expand Down
1 change: 1 addition & 0 deletions web/public/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
rules/
6 changes: 6 additions & 0 deletions web/public/css/bootstrap-5.3.3.min.css

Large diffs are not rendered by default.

Binary file added web/public/img/capa-default-pma0101.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added web/public/img/capa-rule-create-socket.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added web/public/img/capa-vv-pma0101.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added web/public/img/capa.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added web/public/img/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading