Skip to content

Next: Package, Tests, New layout and more.#3

Merged
RenanMsV merged 26 commits into
mainfrom
dev
Apr 29, 2026
Merged

Next: Package, Tests, New layout and more.#3
RenanMsV merged 26 commits into
mainfrom
dev

Conversation

@RenanMsV
Copy link
Copy Markdown
Owner

No description provided.

RenanMsV added 26 commits April 15, 2026 20:56
- Uses Jinja2 to easily inject data into html templates.
- Teweaked the parser.
- Better logging.
- Better output layout and design.
- Now outputs to a json too.
The script will download the latest Nasal folder from GitLab to the folder: `./FGROOT/FGDATA`

- .bat file for Windows.
- .sh file for Linux.
- Keep a Changelog format.
- Core test: Test if API is importable.
- Parser test: Tests the parser.
- Generator test: Test the generated HTML and JSON.
- Running pylint and flake8 in the GH Actions workflow test before pytest.
- Pylint warning disabled for cyclic-import in generator.py.
- Due to deprecation of node 20, must update from checkout v4 to a newer.
More: https://github.blog/changelog/2025-09-19-deprecation-of-node-20-on-github-actions-runners/
- Make sure to run the script to download FGDATA before using this.
Added tests.

- Core test: Test if API is importable.
- Parser test: Tests the parser.
- Generator test: Test the generated HTML and JSON.
- Running pylint and flake8 in the GH Actions workflow test before pytest.
- Pylint warning disabled for cyclic-import in generator.py.
- must install it manually
Release process:

1. Maintainers MUST create releases as pre-releases first.

2. The workflow will:
   - build the package
   - upload it to TestPyPI
   - install and validate it

3. If validation succeeds:
   - the pre-release can be promoted to a full release
   - the workflow will then publish to PyPI

4. If validation fails:
   - fix the issue
   - recreate the pre-release

⚠️ Once a version is published to PyPI, it must NEVER be reused.
If a release fails after being published to PyPI, a new version must be created.
@RenanMsV RenanMsV marked this pull request as ready for review April 29, 2026 21:12
@RenanMsV RenanMsV merged commit ee40a59 into main Apr 29, 2026
2 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.

1 participant