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
79 changes: 79 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
name: Bug report
description: Report a reproducible dirPathPerms problem
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Thanks for reporting a problem. Do not paste tokens, passwords,
SSH keys, or private host details, and redact sensitive paths.

- type: input
id: version
attributes:
label: dirPathPerms version
description: Provide a release tag or commit SHA.
placeholder: v0.1.0 or 0123456
validations:
required: true

- type: dropdown
id: component
attributes:
label: Component
options:
- Interactive prompts or input validation
- Permission checking logic
- Output formatting or colors
- Input file handling
- CI or release automation
- Documentation
validations:
required: true

- type: dropdown
id: platform
attributes:
label: Platform
options:
- Linux (GNU coreutils)
- macOS
- Windows Subsystem for Linux (WSL)
- BSD or other Unix
- Not platform-specific
validations:
required: true

- type: textarea
id: environment
attributes:
label: Environment
description: Include the OS, Bash version (`bash --version`), and `stat --version` output. Redact private details.
validations:
required: true

- type: textarea
id: what-happened
attributes:
label: What happened?
description: Describe the observed and expected behavior.
validations:
required: true

- type: textarea
id: reproduction
attributes:
label: Steps to reproduce
placeholder: |
1. Run ...
2. Observe ...
3. Expected ...
validations:
required: true

- type: textarea
id: logs
attributes:
label: Relevant redacted output
description: Remove secrets and private infrastructure details before pasting.
render: shell
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: Security vulnerability
url: https://github.com/iamteedoh/dirPathPerms/security/advisories/new
about: Report security issues privately, not as public issues.
- name: Question or discussion
url: https://github.com/iamteedoh/dirPathPerms/discussions
about: Ask usage questions and discuss ideas with the community.
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: Feature request
description: Suggest a dirPathPerms improvement
labels: ["enhancement"]
body:
- type: textarea
id: problem
attributes:
label: Problem or motivation
description: What permission-auditing task is difficult today?
validations:
required: true

- type: textarea
id: proposal
attributes:
label: Proposed solution
description: Describe the desired behavior, prompts, or output.
validations:
required: true

- type: textarea
id: safety
attributes:
label: Safety considerations
description: Note anything that would change the script from read-only reporting, affect how untrusted paths are handled, or alter output parsing.

- type: textarea
id: alternatives
attributes:
label: Alternatives considered
description: Describe other approaches or workarounds you considered.
23 changes: 23 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<!-- Thanks for contributing to dirPathPerms! -->

## What does this PR do?

<!-- Briefly describe the change and why it is needed. -->

## Related issue

<!-- Link the public issue this addresses, for example: Closes #123. -->

## Validation

<!-- List the commands and manual checks you ran. -->

## Checklist

- [ ] `git ls-files '*.sh' | xargs shellcheck` passes
- [ ] `git ls-files '*.sh' | xargs -n1 bash -n` passes
- [ ] gitleaks reports no secrets in Git history
- [ ] Scripts and programs include a GPL-3.0-or-later SPDX header
- [ ] No secrets, tokens, credentials, or private infrastructure details are committed
- [ ] Documentation is updated for user-visible or operational changes
- [ ] The PR title follows Conventional Commits
108 changes: 108 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
---
## Author: Tito Valentin
## Name of Program: dirPathPerms Continuous Integration
## Date Created: 2026-07-13
## Description: Validates source quality, secrets, and OSS release requirements.
name: CI

on:
push:
branches: [main]
pull_request:

permissions:
contents: read

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true

jobs:
lint-test:
name: Lint & test
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v7
with:
persist-credentials: false

- name: Run ShellCheck
run: git ls-files '*.sh' | xargs shellcheck

- name: Check Bash syntax
run: git ls-files '*.sh' | xargs -n1 bash -n

secrets:
name: Secret scan
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v7
with:
fetch-depth: 0
persist-credentials: false

- name: Install gitleaks
env:
GITLEAKS_VERSION: 8.30.1
GITLEAKS_SHA256: 551f6fc83ea457d62a0d98237cbad105af8d557003051f41f3e7ca7b3f2470eb
run: |
archive="gitleaks_${GITLEAKS_VERSION}_linux_x64.tar.gz"
curl -sSfLo "/tmp/${archive}" \
"https://github.com/gitleaks/gitleaks/releases/download/v${GITLEAKS_VERSION}/${archive}"
echo "${GITLEAKS_SHA256} /tmp/${archive}" | sha256sum --check
tar -xzf "/tmp/${archive}" -C /tmp gitleaks

- name: Scan the full Git history
run: /tmp/gitleaks git . --config .gitleaks.toml --redact --no-banner

community-files:
name: OSS community & licensing files
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v7
with:
persist-credentials: false

- name: Require community health and licensing files
shell: bash
run: |
fail=0
require() {
if [ ! -s "$1" ]; then
echo "::error::missing or empty: $1"
fail=1
fi
}

require LICENSE
require README.md
require CONTRIBUTING.md
require CODE_OF_CONDUCT.md
require SECURITY.md
require CHANGELOG.md
require .github/FUNDING.yml
require .github/pull_request_template.md
require .github/ISSUE_TEMPLATE/bug_report.yml
require .github/ISSUE_TEMPLATE/feature_request.yml

if ! grep -q "GNU GENERAL PUBLIC LICENSE" LICENSE \
|| ! grep -q "Version 3" LICENSE; then
echo "::error::LICENSE is not GNU GPL v3"
fail=1
fi

if ! grep -qE '^\s*(github|patreon|open_collective|ko_fi|buy_me_a_coffee|liberapay|custom):' \
.github/FUNDING.yml; then
echo "::error::.github/FUNDING.yml has no sponsor or payment link"
fail=1
fi

while IFS= read -r file; do
if ! head -n 8 "$file" | grep -q 'SPDX-License-Identifier: GPL-3.0-or-later'; then
echo "::error file=${file}::missing GPL-3.0-or-later SPDX header"
fail=1
fi
done < <(git ls-files '*.sh')

[ "$fail" -eq 0 ] || exit 1
echo "All required OSS community and licensing checks passed."
27 changes: 27 additions & 0 deletions .github/workflows/release-please.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
## Author: Tito Valentin
## Name of Program: dirPathPerms Release Automation
## Date Created: 2026-07-13
## Description: Creates source-only releases from Conventional Commit history.
name: release-please

# dirPathPerms is distributed as source. Merging the generated release PR
# updates the changelog and version marker, creates a vX.Y.Z tag, and publishes
# a GitHub Release. There is intentionally no binary build or artifact upload.
on:
push:
branches: [main]

permissions:
contents: write
issues: write
pull-requests: write

jobs:
release-please:
runs-on: ubuntu-latest
steps:
- uses: googleapis/release-please-action@v5
with:
config-file: release-please-config.json
manifest-file: .release-please-manifest.json
9 changes: 9 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Environment files
.env

# OS artifacts
.DS_Store

# Editor artifacts
*.swp
*.swo
8 changes: 8 additions & 0 deletions .gitleaks.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
## Author: Tito Valentin
## Name of Program: dirPathPerms Gitleaks Configuration
## Date Created: 2026-07-13
## Description: Extends the default Gitleaks rules for repository history scans.
title = "dirPathPerms gitleaks configuration"

[extend]
useDefault = true
3 changes: 3 additions & 0 deletions .release-please-manifest.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
".": "0.0.0"
}
10 changes: 10 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Changelog

All notable changes to dirPathPerms are documented here.

This project uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
Release entries are maintained by release-please from Conventional Commit PR
titles merged into `main`.

There are no tagged releases yet. The first releasable `feat:` or `fix:` change
will prepare the initial source release.
Loading