Skip to content

docs: standardize README#76

Merged
rubenhensen merged 2 commits into
mainfrom
standardize-readme
Apr 15, 2026
Merged

docs: standardize README#76
rubenhensen merged 2 commits into
mainfrom
standardize-readme

Conversation

@dobby-coder

@dobby-coder dobby-coder Bot commented Apr 14, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Standardize README to point to docs.postguard.eu for full documentation
  • Include quick project description, development quickstart, and release instructions

Closes encryption4all/postguard-docs#8 (partially)

🤖 Generated with Claude Code

Point to docs.postguard.eu for full documentation and include
development quickstart and release instructions.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@rubenhensen

Copy link
Copy Markdown
Contributor

/dobby fix the broken pipeline check. Also add such a semantic PR title check to every active repo in this organisation.

@dobby-coder

dobby-coder Bot commented Apr 15, 2026

Copy link
Copy Markdown
Contributor Author

Dobby has seen the request, sir! Dobby is most eager to help! 🧦

Dobby will fix the broken pipeline check right away, and then Dobby will add the semantic PR title check to every active repo in the organisation. Dobby is a good elf and will not rest until it is done!

Dobby is reading his notes and cloning the repository now...

@dobby-coder dobby-coder Bot changed the title Standardize README docs: standardize README Apr 15, 2026
@dobby-coder

dobby-coder Bot commented Apr 15, 2026

Copy link
Copy Markdown
Contributor Author

Status update

1. Fixed the broken pipeline check ✅

The "Conventional Commit" check was failing because the PR title "Standardize README" didn't follow conventional commit format. I've renamed it to docs: standardize README, which should now pass.

2. Fixed PR titles on all open standardize-readme PRs ✅

I proactively fixed the titles on all 15 open standardize-readme PRs across the org so they'll pass the check once the workflow is added:

Repo PR New title
postguard #130 docs: standardize README
postguard-js #15 docs: standardize README
postguard-dotnet #4 docs: standardize README
postguard-tb-addon #71 docs: add PostGuard logo to README
postguard-examples #10 docs: add standardized README
cryptify #94 docs: standardize README
postguard-outlook-addon #9 docs: standardize README
pdf-signature #1 docs: standardize README
pg-components #5 docs: standardize README
pg-example #11 docs: standardize README
ibs #2 docs: standardize README
postguard-fallback #1 docs: standardize README
irmaseal-mail-utils #4 docs: standardize README
ibe #11 docs: standardize README
pg-curve #1 docs: standardize README

3. Adding the PR title check to all active repos ⚠️

I was unable to add the workflow file to other repos because the Dobby GitHub App doesn't have the workflows permission scope. This is a GitHub security restriction — any token (PAT or App) needs explicit workflows permission to create or modify files under .github/workflows/.

Two options to resolve this:

Option A: Run the script below (quick, one-time)

A human with a PAT that has repo + workflow scopes can run this script to add the check to all 16 repos:

#!/bin/bash
# Usage: GH_TOKEN=ghp_your_token bash add-pr-title-check.sh
# Or: gh auth login first with a PAT that has workflow scope

set -euo pipefail

WORKFLOW_CONTENT='name: PR Title

on:
  pull_request:
    types: [opened, edited, synchronize, reopened]

jobs:
  lint-pr-title:
    name: Conventional Commit
    runs-on: ubuntu-latest
    steps:
      - uses: amannn/action-semantic-pull-request@v5
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
'

REPOS=(
  "postguard-docs:main"
  "postguard-tb-addon:main"
  "postguard-examples:main"
  "postguard-js:main"
  "postguard-dotnet:main"
  "postguard:main"
  "cryptify:main"
  "postguard-outlook-addon:master"
  "pdf-signature:main"
  "pg-components:main"
  "pg-example:master"
  "ibs:main"
  "postguard-fallback:master"
  "irmaseal-mail-utils:master"
  "ibe:main"
  "pg-curve:main"
)

BRANCH="ci/add-pr-title-check"
TMPDIR=$(mktemp -d)

for entry in "${REPOS[@]}"; do
  repo="${entry%%:*}"
  default_branch="${entry##*:}"

  echo "=== $repo (default: $default_branch) ==="

  if gh api "repos/encryption4all/$repo/contents/.github/workflows/pr-title.yml" &>/dev/null; then
    echo "  Already has pr-title.yml, skipping"
    continue
  fi

  existing_pr=$(gh pr list --repo "encryption4all/$repo" --head "$BRANCH" --json number --jq '.[0].number' 2>/dev/null || true)
  if [ -n "$existing_pr" ]; then
    echo "  PR #$existing_pr already exists, skipping"
    continue
  fi

  rm -rf "$TMPDIR/$repo"
  git clone --depth 1 "https://github.com/encryption4all/$repo.git" "$TMPDIR/$repo" 2>/dev/null
  cd "$TMPDIR/$repo"
  git checkout -b "$BRANCH"
  mkdir -p .github/workflows
  echo "$WORKFLOW_CONTENT" > .github/workflows/pr-title.yml
  git add .github/workflows/pr-title.yml
  git commit -m "ci: add semantic PR title check"
  git push -u origin "$BRANCH" 2>/dev/null

  gh pr create --repo "encryption4all/$repo" \
    --title "ci: add semantic PR title check" \
    --body "## Summary
- Add PR title linting with [amannn/action-semantic-pull-request](https://github.com/amannn/action-semantic-pull-request)
- Enforces conventional commit format on PR titles (e.g. \`feat:\`, \`fix:\`, \`docs:\`, \`chore:\`)
- Part of standardizing CI checks across all encryption4all repos

Refs: encryption4all/postguard-website#76" --draft

  echo "  ✓ PR created"
  cd /
done

rm -rf "$TMPDIR"
echo "Done!"

Option B: Add workflows permission to the Dobby app (permanent fix)

Go to the Dobby GitHub App settings → Configure → Permissions → Repository permissions → Workflows → set to Read and write. This would let me handle workflow files in future tasks.

@rubenhensen rubenhensen marked this pull request as ready for review April 15, 2026 21:35
@rubenhensen rubenhensen merged commit 4d6dc94 into main Apr 15, 2026
6 of 7 checks passed
@dobby-coder dobby-coder Bot deleted the standardize-readme branch April 30, 2026 20:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Centralize all postguard documentation

1 participant