Skip to content

Add automatic releases and open-source project setup - #2

Merged
moustafarhat merged 1 commit into
masterfrom
release-and-community
Sep 27, 2026
Merged

moustafarhat merged 1 commit into
masterfrom
release-and-community

Conversation

@moustafarhat

Copy link
Copy Markdown
Owner

Summary

Makes Math Game publish releases automatically and sets the repo up as a proper open-source project.

Automatic releases (.github/workflows/release.yml)

  • Trigger: every push to master reads <Version> from MathGame/MathGame.csproj. If there's no release for that version yet, the workflow runs.
  • Build: each platform is tested and packaged on its own runner:
    • win-x64: .zip
    • linux-x64: .tar.gz
    • osx-arm64 and osx-x64: an ad-hoc signed Math Game.app with an icon, zipped
  • Publish: creates release v<Version> with a download table and auto-generated notes.
  • No version bump: no release. Pull requests: run the same packaging without releasing, so this PR tests it.

Merging this PR publishes v3.0.0, the first release.

Open-source setup

  • Docs:
    • README with logo, badges, screenshots, download table and roadmap
    • CONTRIBUTING.md, with a step-by-step guide to adding a new kind of question
    • CODE_OF_CONDUCT.md, SECURITY.md, CHANGELOG.md
    • MIT LICENSE
  • GitHub config: issue forms (bug, feature, new skill idea), a PR template, CodeQL and Dependabot.
  • CI: now just build and test on Windows, Linux and macOS.

Game changes

  • Wrong answers now show what your pick actually works out to (Your pick: 4 + 2 + 4 = 10). The explanation lists every correct option, not just one.
  • The map shows the app version, which the bug report form asks for.

Test plan

  • dotnet test: 134 passed
  • Checked in the app on Windows: map with version, wrong-answer explanation (screenshots in docs/)
  • Release workflow packaging passes for all 4 targets on this PR
  • After merge: v3.0.0 appears under Releases with 4 downloads

🤖 Generated with Claude Code

Releases: every push to master reads <Version> from MathGame.csproj and,
if that version has no release yet, tests and packages Windows, Linux and
macOS (Apple Silicon + Intel, as an ad-hoc signed .app with an icon) on
their native runners, then publishes v<Version> with download notes.
Pull requests run the same packaging without releasing.

Project: MIT license, README with screenshots, badges and roadmap,
CONTRIBUTING (with a guide to adding a skill), Code of Conduct,
security policy, changelog, issue forms (bug, feature, new skill),
PR template, CodeQL and Dependabot. CI now only builds and tests on
Windows, Linux and macOS.

Game: wrong answers now show what the pick works out to
("Your pick: 4 + 2 + 4 = 10") and every correct option, not just one.
The map shows the app version for bug reports.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@github-advanced-security

Copy link
Copy Markdown

You are seeing this message because GitHub Code Scanning has recently been set up for this repository, or this pull request contains the workflow file for the Code Scanning tool.

What Enabling Code Scanning Means:

  • The 'Security' tab will display more code scanning analysis results (e.g., for the default branch).
  • Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results.
  • You will be able to see the analysis results for the pull request's branch on this overview once the scans have completed and the checks have passed.

For more information about GitHub Code Scanning, check out the documentation.

@moustafarhat
moustafarhat merged commit 6448752 into master Sep 27, 2026
11 checks passed
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.

2 participants