jakubxyz/terminal-ui
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Remove CodeQL workflow, add GitHub Pages deployment, and update project documentation

Browse Source 
- Remove `codeql.yml` workflow for static security analysis.
- Add `pages.yml` workflow for deploying docs to GitHub Pages.
- Introduce `CODE_OF_CONDUCT.md` and `FUNDING.yml`.
- Update `README.md` with links to GitHub Pages and additional project setup details.
- Refine release workflow by splitting build and publish steps, and allowing publish errors for existing versions.
This commit is contained in:
!verity
2026-03-14 10:06:31 +01:00
parent b2a08a2c30
commit 34b683aacf
8 changed files with 91 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
.github/workflows/ci.yml vendored
View File

@@ -6,7 +6,6 @@ on:
pull_request: pull_request:
branches: [ main, master ] branches: [ main, master ]
# Alte Läufe abbrechen, wenn ein neuer Push kommt (spart Zeit)
concurrency: concurrency:
group: ${{ github.workflow }}-${{ github.ref }} group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true cancel-in-progress: true

42
.github/workflows/codeql.yml vendored
View File

@@ -1,42 +0,0 @@
# CodeQL: static security analysis (free for public repos).
name: CodeQL
on:
push:
branches: [ main, master ]
pull_request:
branches: [ main, master ]
schedule:
- cron: '0 6 * * 1'
jobs:
analyze:
runs-on: ubuntu-latest
permissions:
security-events: write
actions: read
contents: read
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Set up JDK 21
uses: actions/setup-java@v4
with:
distribution: temurin
java-version: 21
cache: gradle
- name: Initialize CodeQL
uses: github/codeql-action/init@v3
with:
languages: java
- name: Build (for CodeQL)
run: |
chmod +x gradlew
./gradlew compileJava --no-daemon
- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v3

53
.github/workflows/pages.yml vendored Normal file
View File

@@ -0,0 +1,53 @@
# Deploy docs to GitHub Pages (optional)
# Enable in repo: Settings → Pages → Source: GitHub Actions
# Site will be at https://jakubbbdev.github.io/terminal-ui/
name: Pages
on:
push:
branches: [master, main]
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
jobs:
deploy:
runs-on: ubuntu-latest
environment: github-pages
steps:
- uses: actions/checkout@v4
- name: Setup Pages
uses: actions/configure-pages@v4
- name: Build site
run: |
mkdir -p _site
cp -r docs _site/
cat > _site/index.html << 'EOF'
<!DOCTYPE html>
<html><head><meta charset="utf-8"><title>terminal-ui</title></head>
<body style="font-family:sans-serif;max-width:600px;margin:2rem auto;padding:0 1rem">
<h1>terminal-ui</h1>
<p>Java library for terminal UIs: tables, prompts, menus, and more.</p>
<ul>
<li><a href="https://github.com/jakubbbdev/terminal-ui">GitHub repo</a></li>
<li><a href="https://github.com/jakubbbdev/terminal-ui#install">Install (README)</a></li>
<li><a href="https://github.com/jakubbbdev/terminal-ui/releases">Releases</a></li>
<li><a href="https://github.com/jakubbbdev/terminal-ui/tree/master/docs">Docs (markdown)</a></li>
</ul>
</body></html>
EOF
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: _site
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4

9
.github/workflows/release.yml vendored
View File

@@ -29,10 +29,15 @@ jobs:
- name: Strip v from version - name: Strip v from version
run: echo "RELEASE_VERSION=${RELEASE_VERSION#v}" >> $GITHUB_ENV run: echo "RELEASE_VERSION=${RELEASE_VERSION#v}" >> $GITHUB_ENV
- name: Build and publish to GitHub Packages - name: Build
run: chmod +x gradlew && ./gradlew build publish --no-daemon run: chmod +x gradlew && ./gradlew build --no-daemon
- name: Publish to GitHub Packages
run: ./gradlew publish --no-daemon
env: env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
continue-on-error: true
# 409 = version already exists; use a new tag (e.g. v1.0.2) next time
- name: Create Release - name: Create Release
uses: softprops/action-gh-release@v2 uses: softprops/action-gh-release@v2

1
.idea/misc.xml generated
View File

@@ -1,4 +1,3 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4"> <project version="4">
<component name="ExternalStorageConfigurationManager" enabled="true" /> <component name="ExternalStorageConfigurationManager" enabled="true" />
<component name="FrameworkDetectionExcludesConfiguration"> <component name="FrameworkDetectionExcludesConfiguration">

17
CODE_OF_CONDUCT.md Normal file
View File

@@ -0,0 +1,17 @@
# Code of Conduct
## Our Pledge
We are committed to providing a welcoming and harassment-free experience for everyone. Be respectful, inclusive, and constructive when contributing or discussing this project.
## Unacceptable Behavior
Harassment, trolling, insulting comments, personal or political attacks, and other conduct that could make others feel unsafe are not acceptable.
## Enforcement
Maintainers may remove or edit content that violates this code. Repeated or serious violations may result in being blocked from the repository.
## Contact
If you have concerns, open an issue or contact the maintainers privately if preferred.

5
FUNDING.yml Normal file
View File

@@ -0,0 +1,5 @@
# Optional: Uncomment to show "Sponsor" button on the repo
# github: [jakubbbdev]
# patreon: your-username
# ko_fi: your-username
# custom: ['https://your-link.com']

9
README.md
View File

@@ -5,9 +5,12 @@ Java library for terminal UI: tables, rules, colors, prompts, menus, SelectList,
[![CI](https://github.com/jakubbbdev/terminal-ui/actions/workflows/ci.yml/badge.svg)](https://github.com/jakubbbdev/terminal-ui/actions/workflows/ci.yml) [![CI](https://github.com/jakubbbdev/terminal-ui/actions/workflows/ci.yml/badge.svg)](https://github.com/jakubbbdev/terminal-ui/actions/workflows/ci.yml)
[![Java 21](https://img.shields.io/badge/Java-21-ED8B00?logo=openjdk)](https://openjdk.org/) [![Java 21](https://img.shields.io/badge/Java-21-ED8B00?logo=openjdk)](https://openjdk.org/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
[![Latest release](https://img.shields.io/github/v/release/jakubbbdev/terminal-ui)](https://github.com/jakubbbdev/terminal-ui/releases)
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/jakubbbdev/terminal-ui) [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/jakubbbdev/terminal-ui)
**First time here?** → [NEXT_STEPS.md](NEXT_STEPS.md) has a short checklist (Pages, topics, release).
## Install ## Install
Published to [GitHub Packages](https://github.com/jakubbbdev/terminal-ui/packages). Replace `VERSION` with a [release](https://github.com/jakubbbdev/terminal-ui/releases) tag (e.g. `1.0.0`). Published to [GitHub Packages](https://github.com/jakubbbdev/terminal-ui/packages). Replace `VERSION` with a [release](https://github.com/jakubbbdev/terminal-ui/releases) tag (e.g. `1.0.0`).
@@ -95,6 +98,12 @@ String choice = Terminal.menu()
.select(); .select();
``` ```
## Docs & links
- **In-repo docs:** [docs/](docs/) – Home, Install, Components, Examples.
- **GitHub Pages:** Enable in **Settings → Pages → Source: GitHub Actions** (uses workflow `pages.yml`). Site: `https://jakubbbdev.github.io/terminal-ui/`.
- **Wiki:** **Settings → Features** → enable **Wiki**; copy content from `docs/` if you like.
## License ## License
See [LICENSE](LICENSE). See [LICENSE](LICENSE).