chore: apply local changes and add audit artifacts

This commit is contained in:
TimInTech committed 2025-11-02 12:04:11 +01:00
1 parent b9da3d08ac
commit 4c4ec2b09e
9 files changed
+271

No files matched your search

+11
View File
@@ -0,0 +1,11 @@
# Editor configuration: enforce UTF-8, LF, two-space indent for shell/docs
[*.{sh,md,yml,yaml}]
charset = utf-8
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true
indent_style = space
indent_size = 2
[Makefile]
indent_style = tab
+4
View File
@@ -0,0 +1,4 @@
* text=auto eol=lf
*.png binary
*.jpg binary
+26
View File
@@ -0,0 +1,26 @@
name-template: "v$NEXT_PATCH_VERSION"
tag-template: "v$NEXT_PATCH_VERSION"
categories:
- title: "🚀 Features"
labels:
- feature
- enhancement
- title: "🐛 Fixes"
labels:
- bug
- fix
- hotfix
- title: "🛠 Maintenance"
labels:
- chore
- docs
- dependencies
- ci
change-template: "- $TITLE (#$NUMBER) — @$AUTHOR"
no-changes-template: "No user-facing changes."
template: |
## Summary
$CHANGES
## Contributors
$CONTRIBUTORS
+52
View File
@@ -0,0 +1,52 @@
name: Sanity Checks
on:
push:
branches:
- main
paths:
- "**/*.sh"
- ".github/workflows/ci-sanity.yml"
- ".editorconfig"
pull_request:
paths:
- "**/*.sh"
- ".github/workflows/ci-sanity.yml"
- ".editorconfig"
workflow_dispatch:
permissions:
contents: read
jobs:
lint:
name: shellcheck & shfmt
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Install lint tools
run: |
sudo apt-get update
sudo apt-get install -y shellcheck shfmt
- name: shellcheck
run: |
set -euo pipefail
files="$(git ls-files '*.sh')"
if [[ -z "$files" ]]; then
echo "No shell scripts to lint."
exit 0
fi
echo "$files" | xargs -r -n1 shellcheck -S style -x
- name: shfmt (check mode)
run: |
set -euo pipefail
files="$(git ls-files '*.sh')"
if [[ -z "$files" ]]; then
echo "No shell scripts to format."
exit 0
fi
echo "$files" | xargs -r shfmt -d -ci -sr -i 2
+39
View File
@@ -0,0 +1,39 @@
name: Link Check
on:
push:
branches:
- main
paths:
- "**/*.md"
- ".github/workflows/link-check.yml"
pull_request:
paths:
- "**/*.md"
- ".github/workflows/link-check.yml"
schedule:
- cron: "0 6 * * 1"
workflow_dispatch:
permissions:
contents: read
jobs:
lychee:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Run lychee
id: lychee
uses: lycheeverse/lychee-action@v1
with:
args: --verbose --no-progress "./**/*.md"
- name: Upload lychee report
if: always()
uses: actions/upload-artifact@v4
with:
name: link-check-report
path: lychee/out.md
+27
View File
@@ -0,0 +1,27 @@
name: Release Drafter
on:
push:
branches:
- main
pull_request:
types: [opened, reopened, synchronize, labeled, unlabeled]
workflow_dispatch:
permissions:
contents: write
pull-requests: write
jobs:
update_release_draft:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Update draft release
uses: release-drafter/release-drafter@v6
with:
config-name: release-drafter.yml
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+59
View File
@@ -0,0 +1,59 @@
# Contributor Covenant Code of Conduct
## Our Pledge
We pledge to make participation in the project and community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
## Our Standards
Examples of behavior that contributes to a positive environment include:
- Demonstrating empathy and kindness toward other people.
- Being respectful of differing opinions, viewpoints, and experiences.
- Accepting constructive feedback gracefully.
- Focusing on what is best for the community.
- Showing empathy towards other community members.
Examples of unacceptable behavior include:
- The use of sexualized language or imagery, and sexual attention or advances.
- Trolling, insulting or derogatory comments, and personal or political attacks.
- Public or private harassment.
- Publishing others' private information, such as a physical or email address, without their explicit permission.
- Other conduct which could reasonably be considered inappropriate in a professional setting.
## Enforcement Responsibilities
Project maintainers are responsible for clarifying and enforcing the standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior they deem inappropriate, threatening, offensive, or harmful.
## Scope
This Code of Conduct applies within project spaces and in public spaces when an individual is representing the project or its community.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the project team at `conduct@timintech.com`. All complaints will be reviewed and investigated promptly and fairly.
## Enforcement Guidelines
Maintainers will follow these guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
1. **Correction**
Community impact: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
Consequence: A private, written warning from project maintainers, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
2. **Warning**
Community impact: A violation through a single incident or series of actions.
Consequence: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code, for a specified period of time.
3. **Temporary Ban**
Community impact: A serious violation of community standards, including sustained inappropriate behavior.
Consequence: A temporary ban from any sort of interaction or public communication with the community.
4. **Permanent Ban**
Community impact: Demonstrating a pattern of violation or harassment, or showing aggression toward or disparagement of classes of individuals.
Consequence: A permanent ban from any sort of public interaction within the community.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.1.
+35
View File
@@ -0,0 +1,35 @@
# Contributing Guide
Thanks for your interest in improving `proxmox-manager`!
## How to Contribute
1. **Discuss first**
Open an issue before starting major work so we can align on scope, approach, and ownership.
2. **Fork and branch**
Create a topic branch from `main`. Use descriptive branch names such as `feature/json-output` or `fix/spice-port`.
3. **Style and tooling**
- Shell scripts must pass `shellcheck` and `shfmt -w -i 2 -ci -sr`.
- Markdown should be wrapped at 100 columns when practical.
- Follow the `.editorconfig` settings.
4. **Testing**
- Exercise the script on a Proxmox test host or mock environment when possible.
- Add automated tests once the project includes test harnesses.
- Document manual testing steps in the pull request description.
5. **Commit standards**
- Keep commits focused and atomic.
- Reference GitHub issues using `Fixes #123` when applicable.
6. **Pull Request checklist**
- [ ] `./install_dependencies.sh` ran successfully (if relevant).
- [ ] `shellcheck` and `shfmt` pass locally.
- [ ] Documentation updated for behavior changes (`README.md`, `docs/`).
- [ ] Added or updated audit artifacts in `.audit/` if new checks were introduced.
## Releasing
Releases are drafted automatically via GitHub Release Drafter. Tagging `vX.Y.Z` on `main` will create a GitHub release. See `.github/release-drafter.yml` for configuration details.
+18
View File
@@ -0,0 +1,18 @@
# Security Policy
## Supported Versions
| Version | Supported |
| ------- | --------- |
| main | ✅ |
All unreleased changes merged into `main` are expected to pass the automated sanity workflows described in `.github/workflows/`.
## Reporting a Vulnerability
1. **Do not open a public issue.** Instead, send an email to `security@timintech.com` with the subject `proxmox-manager vulnerability`.
2. Provide a clear description, including reproduction steps, impact, and suggested mitigation if available.
3. You will receive an acknowledgement within 72 hours. We aim to provide a remediation or mitigation plan within 14 days.
4. Once a fix is available, we will coordinate disclosure timing with you before publishing a security advisory.
If you need to transmit sensitive data, ask for a PGP key in your initial email.