Skip to content

Generate a generation.md file containing generation information - #162

Open
pyrollo wants to merge 1 commit into
mainfrom
pyr/git-commit-hash
Open

Generate a generation.md file containing generation information#162
pyrollo wants to merge 1 commit into
mainfrom
pyr/git-commit-hash

Conversation

@pyrollo

@pyrollo pyrollo commented Dec 1, 2025

Copy link
Copy Markdown
Contributor

There is no rush to merge this feature, PR is widely open to discussions.

Changes

For each generation, create a summary file with generation information.

Feature description

A generation.md file is created aside world files, containing generation information:

  • Generation date
  • Git information

Some more information could be added later like generator version, service website, ...

Reason

Main reason is to keep track of commit hash. This will be very useful when users will send us bug reports.

Self-checks

  • The code has unit tests associated
  • The code has Javadoc Comments associated
  • Complex / Unexpected code is explained / justified with a small comment
  • Relevant documentation inside the /docs folder has been updated
  • All examples in examples/ work the same (or have been adapted if subject to changes in this PR)
  • Git history is clean (each commit accomplish a single task and describe it accordingly)
  • The texts have been proofread (documentation, error messages, logs, comments...)

@github-actions

github-actions Bot commented Dec 3, 2025

Copy link
Copy Markdown

[Maven Build Status]

📑 Commit: 64072bb60b96d7ec98a11ea4087603cee496c9c3
⌚️ Date: 2026-02-13T16:34:39 (CET)
🛠️ Status: ✅ Success

📦 Download artifact: Generator.jar

@pyrollo
pyrollo force-pushed the pyr/git-commit-hash branch 2 times, most recently from 01735a0 to 5e988e7 Compare December 4, 2025 12:33
@pyrollo
pyrollo force-pushed the pyr/git-commit-hash branch from 5e988e7 to 64072bb Compare February 13, 2026 15:33
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