Skip to content

Add Python code to license check#8469

Merged
Myoldmopar merged 11 commits intodevelopfrom
add-python-to-check
Feb 9, 2021
Merged

Add Python code to license check#8469
Myoldmopar merged 11 commits intodevelopfrom
add-python-to-check

Conversation

@jasondegraw
Copy link
Member

@jasondegraw jasondegraw commented Jan 14, 2021

Pull request overview

The current license checker doesn't check Python files, this addresses that shortcoming and expands the coverage of C/C++ a little (a newer subdirectory wasn't getting hit). These files are spread out a bit so the search is a little more broad. This should be merged after #8445.

The script is changed so that it can handle the Python version of the license and all of the Python code that I could find should now have (or will have soon) the correct license.

Fixes #8446

Pull Request Author

Add to this list or remove from it as applicable. This is a simple templated set of guidelines.

  • Title of PR should be user-synopsis style (clearly understandable in a standalone changelog context)
  • Label the PR with at least one of: Defect, Refactoring, NewFeature, Performance, and/or DoNoPublish
  • Author should provide a "walkthrough" of relevant code changes using a GitHub code review comment process

Reviewer

This will not be exhaustively relevant to every PR.

  • Perform a Code Review on GitHub
  • If branch is behind develop, merge develop and build locally to check for side effects of the merge
  • If defect, verify by running develop branch and reproducing defect, then running PR and reproducing fix
  • If feature, test running new feature, try creative ways to break it
  • CI status: all green or justified
  • Check that performance is not impacted (CI Linux results include performance check)
  • Run Unit Test(s) locally
  • Check any new function arguments for performance impacts
  • Verify IDF naming conventions and styles, memos and notes and defaults
  • If new idf included, locally check the err file and other outputs

@jasondegraw jasondegraw added the DoNotPublish Includes changes that shouldn't be reported in the changelog label Jan 14, 2021
@jasondegraw jasondegraw added this to the EnergyPlus 9.5.0 milestone Jan 14, 2021
@Myoldmopar Myoldmopar mentioned this pull request Jan 14, 2021
12 tasks
@Myoldmopar
Copy link
Member

Myoldmopar commented Jan 19, 2021

@Myoldmopar To Do

Fix license in:

  • scripts/diagnostics/afn_auditor.py
  • doc/tools/parse_ems_actuators.py

@Myoldmopar
Copy link
Member

@jasondegraw I fixed the license in the two diagnostic files and the doc tool file. Can you confirm it's all good? I believe it will be ready to go once CI approves and you confirm.

@Myoldmopar
Copy link
Member

Unknown why the github mac instance failed, but it's nothing to do with this. This looks ready to go in now. Am I missing anything @jasondegraw ?

@jasondegraw
Copy link
Member Author

@Myoldmopar No, I don't think you've missed anything, I think this can go in. I pulled it, ran the script, and everything seemed to be in order. The scripting around updating the license year will need to be brought into line with these changes, but that can wait until my annual foray into mass editing.

@Myoldmopar Myoldmopar merged commit d6d98fa into develop Feb 9, 2021
@Myoldmopar Myoldmopar deleted the add-python-to-check branch February 9, 2021 19:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

DoNotPublish Includes changes that shouldn't be reported in the changelog

Projects

None yet

Development

Successfully merging this pull request may close these issues.

License checking does not check Python code

7 participants

Comments