Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
51 changes: 51 additions & 0 deletions .github/workflows/publish_docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
#
# Copyright 2026 ABSA Group Limited
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

name: Publish Docs

on:
release:
types: [ published ]
workflow_dispatch:
inputs:
release-tag:
description: 'Release tag to attach the docs bundle to. Leave empty to use the latest release.'
required: false

jobs:
publish:
name: Publish Docs to the Knowledge Base
runs-on: ubuntu-latest
permissions:
contents: write # required - the action uploads a release asset
steps:
- name: Checkout repository
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1
with:
persist-credentials: false

- name: Render and publish single-page docs
uses: AbsaOSS/knowledge-base/actions/publish-single-page-docs@679ec075cab1e1cdfb1140eedad7f2f80a5b683a
with:
# Which release the docs bundle is attached to
release-tag: ${{ inputs.release-tag || github.event.release.tag_name }}
docs: |
- md: docs/security/security.md
title: Security Automation
description: Turns AquaSec scan findings into a managed GitHub Issues backlog with full lifecycle automation.
slug: org-workflows-security
icon: shield
tags: [security, automation, aquasec, workflows]
12 changes: 6 additions & 6 deletions docs/security/security.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Security Automation provides **continuous, automated vulnerability management** for your repositories. It authenticates directly with the AquaSec API, fetches scan findings, and automatically converts them into structured **GitHub Issues** with full lifecycle management. This gives your team a managed security posture without manual triage effort.

> For setup instructions and technical configuration, see the [Security README](/src/security/README.md).
> For setup instructions and technical configuration, see the [Security README](https://github.com/AbsaOSS/organizational-workflows/blob/master/src/security/README.md).
---

Expand Down Expand Up @@ -50,7 +50,7 @@ flowchart TD
- **Lifecycle automation**: Issues are reopened when findings reappear, automatically closed when resolved, and updated if needed.
- **Notifications**: Option to notify the team of new or reopened security findings in real-time.
- **Priority sync**: Findings are mapped to priority levels on a ProjectV2 board, keeping planning and security aligned.
- **Organisational scale**: Shared reusable workflows mean every repository gets the same security process with a single caller workflow.
- **Organizational scale**: Shared reusable workflows mean every repository gets the same security process with a single caller workflow.

---

Expand Down Expand Up @@ -179,12 +179,12 @@ Adopt the security automation by adding a short caller workflow to your reposito

### Example Caller Workflow

See the full example at [docs/security/aquasec-night-scan-example.yml](/docs/security/aquasec-night-scan-example.yml).
See the full example at [aquasec-night-scan-example.yml](https://github.com/AbsaOSS/organizational-workflows/blob/master/docs/security/aquasec-night-scan-example.yml).

---

## See Also

- [Security README](/src/security/README.md): setup instructions, shared workflow configuration, and technical details
- [Example Caller Workflow](/docs/security/aquasec-night-scan-example.yml): ready-to-copy workflow file for your repository
- [Repository README](/README.md): overview of all organizational workflows
- [Security README](https://github.com/AbsaOSS/organizational-workflows/blob/master/src/security/README.md): setup instructions, shared workflow configuration, and technical details
- [Example Caller Workflow](https://github.com/AbsaOSS/organizational-workflows/blob/master/docs/security/aquasec-night-scan-example.yml): ready-to-copy workflow file for your repository
- [Repository README](https://github.com/AbsaOSS/organizational-workflows/blob/master/README.md): overview of all organizational workflows