GitHub Action
Flexion Tech Radar Generator
v0.1.3
Latest version
A tech radar is a visual representation of the technology landscape within an organization. It helps teams and organizations track the technologies they use or are interested in, and make informed decisions about which technologies to adopt, hold, or retire. Tech radars are useful for both individuals and organizations to stay up-to-date with the latest trends, share knowledge, and facilitate communication about technology choices.
graph LR
MarkdownInput[Markdown] -->|Input| GithubWorkflow
JSONInput[JSON] -.->|Input| GithubWorkflow
GithubWorkflow -->|GithubPagesSite| GithubPages[Github Pages]
GithubWorkflow -->|ZipArtifact| GithubActionArtifact[Github Action Artifact]
subgraph GithubWorkflow
TechRadarAction[flexion/tech-radar-generator]
end
| Name | Description | Required | Default |
|---|---|---|---|
| directory | Folder containing the tech radar data | true | |
| artifact_name | Name of the artifact to upload (optional) | false | |
| publish_to_pages | Publish to Github Pages (optional) | false | "false" |
| public_url | Public URL used for rendering and publishing | false | "./build" |
| radar_name | Name of the radar (optional) | false | "Flexion Tech Radar" |
name: Tech Radar
on:
push:
branches: ['main']
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
generate_tech_radar:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.pages_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Generate Tech Radar
id: deployment
uses: flexion/[email protected]
with:
radar_name: My Radar
directory: ./docs # Directory where the radar directory is located
base_path: /my-repo/techradar # Path after domain, used to generate assets
base_dir: techradar # Location for assets for GH Pages
publish_to_pages: 'true'
- Add parameter for input format for the radar; Markdown is implied, under the AOE radar format "/*.md", but JSON is also supported
- Parametrize radar engine; AOE Radar is implied
- Parametrize radar version
- Extract radar installation to a script
- Add more deployment targets