[META] Improve our CI

[Histalek]

Our CI can be improved in many aspects. Added CI should increase correctness via checks and/or automate actions that would otherwise be manual.

This issue should track all ideas we can come up with and their respective progress.

Pull Requests

• [x] Keep language files tidy with our language parser
  • WIP PR: #1343
  • Follow-up PR: #1348
    • smuggled in via #1346
• [x] Keep a consistent code style with stylua
  • WIP PR: #1245
  • evaluate how this would interact with our current glualint ci
• [ ] Make extensive use of the Lua Language Server and use it to find common errors
  • this is blocked until we switch our code comments to the LLS annotations
• [ ] Check all files against the workshop addon whitelist
• [ ] Check all referenced files (e.g. Material() calls) for inclusion in the project and if they are added to the force-download

Release

• [ ] automate the whole release process on the github side of things
  • Generate the html in cl_changes.lua from the Changelog
    1. extract ## unreleased changelog section
    2. convert it via pandoc --from gfm --to html --standalone
    3. paste the generated html into cl_changes.lua
  • Draft a Pre-Release with the Changes from the Changelog

Other

• [ ] Use stale action instead of the old unmaintained project
• [x] Remove stale-bot

Things that need to be done because of something done here

• [ ] Stylua-FollowUp:
  • add suitable IDE setups in CONTRIBUTING.MD
  • we should probably follow the gmod wiki editors list: VSCode and Neovim do have stylua plugins, sublime text i'm not sure
• [ ] Stylua-FollowUp:
  • NeoDoc cannot handle multiline Convars and hooks, so these are currently -- stylua: ignored
  • Update NeoDoc to properly handle these cases (or rewrite it entirely using a proper lua AST )

[TimGoll]

• Check all referenced files (e.g. Material() calls) for inclusion in the project and if they are added to the force-download

we should probably have a table with the file names that can be iterated by a loop that calls AddFile

[Histalek]

• Check all referenced files (e.g. Material() calls) for inclusion in the project and if they are added to the force-download

we should probably have a table with the file names that can be iterated by a loop that calls AddFile

why? grepping or regexes to check these calls are fast enough. i definitely don't want to maintain a seperate table. That seems unnecessarily error-prone and exhausting.

I should maybe summarize our goals in the OP. One part is correctness another is to have less manual work to do.

[xopez]

• [ ] Keep a consistent code style with stylua

If stylua works great maybe we should recommend the VS Code Extension in this repository. Maybe you wanna think about that. Extension: https://marketplace.visualstudio.com/items?itemName=JohnnyMorganz.stylua Guide: https://code.visualstudio.com/docs/editor/extension-marketplace#_workspace-recommended-extensions

[Histalek]

• [ ] Keep a consistent code style with stylua

If stylua works great maybe we should recommend the VS Code Extension in this repository. Maybe you wanna think about that. Extension: marketplace.visualstudio.com/items?itemName=JohnnyMorganz.stylua Guide: code.visualstudio.com/docs/editor/extension-marketplace#_workspace-recommended-extensions

Yes good point, i'll probably will add a few things to the CONTRIBUTING.md or maybe add some other document that show 1 or 2 example code-editor setups.

[TimGoll]

Check all referenced files (e.g. Material() calls) for inclusion in the project and if they are added to the force-download

might be obsolete by now

[Histalek]

Check all referenced files (e.g. Material() calls) for inclusion in the project and if they are added to the force-download

might be obsolete by now

obsolete in which way exactly? we still have a lot of Material() calls.