Signed-off-by: Dave Thaler <dthaler@ntdev.microsoft.com>
This commit is contained in:
Dave Thaler 2021-05-12 07:23:02 -07:00 коммит произвёл GitHub
Родитель 2b2ea62dee
Коммит 656e7becc1
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
4 изменённых файлов: 2705 добавлений и 0 удалений

46
.github/workflows/update-docs.yml поставляемый Normal file
Просмотреть файл

@ -0,0 +1,46 @@
# Copyright (c) Microsoft Corporation
# SPDX-License-Identifier: MIT
# This action will run doxygen to update the documentation at https://microsoft.github.io/ebpf-for-windows/
# which is a view of the gh-pages branch. This action is done whenever the master branch is updated.
# For docs on gh-pages see https://pages.github.com/
#
# The following two links discuss steps similar to this action so may be useful reading
# to understand how the automatic update works:
# https://growworkinghard.altervista.org/doxygen-documentation-on-github-using-gh-pages/
# https://github.com/m-a-d-n-e-s-s/madness/issues/104
name: Doxygen Action
# Controls when the action will run. Triggers the workflow on push # events
# but only for the master branch
on:
push:
branches: [ master ]
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Install doxygen
run: |
sudo apt install doxygen
- uses: actions/checkout@v2
- name: Clone docs
run: |
git config --global user.email 'ebpf-for-windows@users.noreply.github.com'
git config --global user.name 'Github Action'
git clone --branch gh-pages https://github.com/microsoft/ebpf-for-windows.git docs/html
- name: Update docs
run: |
doxygen
cd docs/html
git commit -s -am "Updated documentation"
git remote set-url origin https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/microsoft/ebpf-for-windows.git
git push

2656
Doxyfile Normal file

Разница между файлами не показана из-за своего большого размера Загрузить разницу

Просмотреть файл

@ -47,6 +47,8 @@ and a few binaries just used for demo'ing eBPF functionality, as in the demo wal
If you're not already familiar with eBPF, or want a detailed walkthrough, see our [eBPF tutorial](tutorial.md).
For API documentation, see https://microsoft.github.io/ebpf-for-windows/
This section shows how to use eBPF for Windows in a demo that defends against a 0-byte UDP attack on a DNS server.
### Prep

Просмотреть файл

@ -13,6 +13,7 @@ tools/netsh/resource.h
# Other Files
LICENSE.txt
Doxyfile
\.check-license\.ignore
\.clang-format
\.gitattributes