nov 2025 housekeeping #392
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Replace abbreviated license notice with complete Apache License 2.0 text as recommended by Apache Foundation licensing best practices. This ensures proper legal compliance and clarity.
Add .cursor/ directory to .gitignore alongside existing .cursorrules exclusion to prevent committing Cursor IDE configuration files.
…ection - Remove reference to non-existent requirements_dev.txt - Install nipyapi as package with [docs] extras instead - This enables setuptools-scm to properly detect version from git tags - Fixes ReadTheDocs builds showing incorrect version (0.19 instead of 1.0+) ReadTheDocs needs the package installed (not just requirements.txt) so that setuptools-scm can generate nipyapi/_version.py from git tags, which is read by docs/conf.py line 72 for version information.
The ignore= parameter in pylintrc doesn't reliably exclude subdirectories in pylint 3.x. This causes CI to scan auto-generated code (nipyapi/nifi/, nipyapi/registry/) which produces duplicate-code warnings and fails lint. Local environments work because the --ignore flag is honored, but GitHub Actions CI was scanning generated code and failing with score 7.32/10. Added regex patterns to ignore-paths to properly exclude: - nipyapi/nifi/ (generated NiFi API code) - nipyapi/registry/ (generated Registry API code) - nipyapi/_version.py (generated version file) This ensures consistent behavior between local and CI environments.
The test-dist target depends on 'dist' which calls 'clean', and clean removes coverage.xml before codecov can upload it. Fixed by reordering CI steps: 1. Run tests with coverage (creates coverage.xml) 2. Upload coverage to Codecov (uses coverage.xml) 3. Test distribution build (clean deletes coverage.xml - no longer needed) This resolves the 'No coverage reports found' error in CI.
Welcome to Codecov 🎉Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests. Thanks for integrating Codecov - We've got you covered ☂️ |
Post-1.0 release cleanup to align documentation with default branch. Updated references: - README.rst: Codecov badge now points to main branch coverage - README.rst: Contribution guide link updated to main branch - docs/conf.py: Sphinx source code links now reference main branch The NiFi2x branch was the development branch for the 2.x upgrade. Now that 1.0 is released, main is the default branch.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request includes several updates focused on maintenance, documentation, and workflow improvements. The key changes update licensing information, improve CI workflow reliability, modernize documentation references, and refine code quality settings.
Licensing and Legal Updates:
LICENSEwith the full Apache License 2.0, including all terms and conditions.Continuous Integration Workflow Improvements:
.github/workflows/ci.ymlso that the distribution build test (make test-dist) and infrastructure teardown (make down) occur after code coverage is uploaded, ensuring coverage is always reported even if later steps fail. [1] [2]Documentation and Reference Updates:
.readthedocs.yamlto use pip'sextra_requirementsfor thedocsextra, streamlining doc builds.README.rstanddocs/conf.pyto reference themainbranch instead of the deprecatedNiFi2xbranch, ensuring all links point to the current default branch. [1] [2] [3]Code Quality Tooling:
ignore-pathssetting inpylintrcto explicitly ignore generated and vendor directories, as well as the version file, improving linter accuracy and performance.