Simple Machines Community Forum

General Community => Site Comments, Issues and Concerns => Topic started by: All Colours Sam on November 21, 2024, 11:09:20 AM

Title: modsite github integration
Post by: All Colours Sam on November 21, 2024, 11:09:20 AM
Its not a rant, don't worry!

Just want to say kudos to the cust team and everyone involved on the github integration, the webhook feature makes it easy to auto update a mod when doing a release and markdown support means I don't have to have separate readme files anymore.
Title: Re: modsite github integration
Post by: live627 on November 23, 2024, 08:24:36 AM
I wholeheartedly agree! I ♥ this automation. We don't get much (any) feedback on this.

I feel like the readme situation could be clarified: The pacckage parser looks for README files within the top level directory. It looks for commonly used file names such as `README.md`, `README.txt`, `readme.md`, and `readme.txt`. Once a README file is detected, the function determines its format. It prioritizes Markdown files (e.g., `README.md`) over bbcode-enabled text files (e.g., `README.txt`). The format is distinguished based on the file extension. The manually entered description is ignored.