Skip to content

Polish README and env examples for OSS launch#7

Merged
mithileshchellappan merged 3 commits into
mainfrom
cleanup
May 1, 2026
Merged

Polish README and env examples for OSS launch#7
mithileshchellappan merged 3 commits into
mainfrom
cleanup

Conversation

@mithileshchellappan

Copy link
Copy Markdown
Owner

Summary

  • Rewrite the README for open-source release with a contents page, clearer positioning, architecture overview, Live Activity coverage, and a direct comparison table against FCM, OneSignal, AWS SNS, and Gorush
  • Update .env.example to match the current server/runtime configuration and remove obsolete SQLite/Firebase placeholders
  • Remove the learnings/ folder from the published repo and add the standard OSS repo files, Docker setup, CI, OpenAPI spec, and license

Testing

  • Ran OpenAPI and YAML validation
  • Ran git diff --check and ASCII checks
  • Ran go test ./...
  • Verified the Docker image and compose stack by building and starting the service locally

@mithileshchellappan mithileshchellappan merged commit b4c19ac into main May 1, 2026
@mithileshchellappan mithileshchellappan deleted the cleanup branch May 1, 2026 12:26

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 2a067645c5

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread scripts/setup.sh
Comment on lines +36 to +37
git -C "$INSTALL_DIR" fetch --tags --depth 1 origin "$VERSION"
git -C "$INSTALL_DIR" checkout --quiet "$VERSION"

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Badge Fast-forward existing installs to fetched version

In scripts/setup.sh, the existing-repo path fetches origin "$VERSION" and then runs git checkout "$VERSION", but this does not advance a local branch (for example main) to the newly fetched commit. In practice, rerunning the installer in an existing ~/pushboy checkout can leave users on stale code even though fetch succeeds, because only remote-tracking refs/FETCH_HEAD were updated. This breaks the script’s update behavior for the most common upgrade flow.

Useful? React with 👍 / 👎.

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.

1 participant