Gitiles
Code Review Sign In
gerrit.opencord.org / onf-make / a3f9aca5a06297832e399a63e92631b69c853b60
commita3f9aca5a06297832e399a63e92631b69c853b60[log] [tgz]
authorJoey Armstrong <joey@opennetworking.org>Sun Feb 11 11:58:11 2024 -0500
committerJoey Armstrong <joey@opennetworking.org>Tue Feb 13 08:36:01 2024 -0500
tree7d16897f78051bcb98c37c41c5fc721e80d39772
parentcacdaa0b72f421fa1250c83fb67a537d064f27fd [diff]
Support groovy lint exclusions

makefiles/utils/include.mk
--------------------------
  o Added helper method path-by-makefile.
  o Derive a path relative to an active makefile.

makefiles/lint/groovy/include.mk
makefiles/lint/groovy/.groovylintrc.json
makefiles/lint/groovy/urls
----------------------------------------
  o make lint-groovy: pass argument --config to npm-groovy-lint.
  o Bulk filter subjective and personal-preference items to help
    shrink logfile size until the warning volume is under control.
  o https://github.com/nvuillam/npm-groovy-lint/blob/main/lib/.groovylintrc-recommended.json

[HOWTO: test]
  % git clone onf-make
  % cd onf-make
  % make lint-groovy HIDE=

Display command line being launched (HIDE=@ cleared):
[...] npm-groovy-lint --config "...../onf-make/makefiles/lint/groovy/.groovylintrc.json"

Change-Id: I0f3bf3f7f949d7911c89e809f1702a1615418ea6
4 files changed
tree: 7d16897f78051bcb98c37c41c5fc721e80d39772
  1. .gitignore
  2. .gitreview
  3. Makefile
  4. README.md
  5. bin/
  6. config.mk
  7. docs/
  8. makefiles/
  9. makefiles_include_mk.ex
README.md

onf-make library makefiles

This repository contains common makefile logic and targets that can be used to build arbitrary repositories. Makefile logic is currently being consumed by the VOLTHA project

makefiles/ subdirectories

Two distinct sets of makefiles are needed to support builds:

  • The first is a subdir of makefiles/ named 'onf-make'

    • This directory exists and is maintained as a git-submodule of repo:onf-make.
    • Library makefiles contain independent logic to install common tools such as (virtualenv), perform linting tasks, define constants and perform path/string manipulation, etc.

  • The second makefile directory contains repository/project specific logic:

    • makefiles/local/ exists as a repository subdirectory under SCM.
    • Contains custom targets, variant parameters and custom logic specific to the repository it exists within.

  • Most makefile logic can be parameterized and implemented to support reuse. Consider adding enhancements or refactoring local/ makefile logic into repo:onf-make so all makefiles can leverage it.

Hierarchy

% tree --charset=ascii -n

Makefile
config.mk
makefiles/
|-- include.mk
|-- local
|   |-- include.mk
|   |   |   |-- doc8
|   |   |   |    |-- doc8.ini   (alas only one --config switch allowed)
|-- [onf-make: git-submodule](https://github.com/opencord/onf-make)
|   |-- makefiles
|   |   |-- consts.mk
|   |   |-- include.mk
|   |   |-- lint
|   |   |   |-- doc8            Syntax check ReStructuredText (rst) files
|   |   |   |-- groovy
|   |   |   |-- python
|   |   |   |-- robot.mk        Syntax check robot testing framework
|   |   |   |-- shell.mk        Invoke shellcheck command on scripts
|   |   |   |-- yaml            Syntax check yaml configs

NOTES

  • Ascii art was rendered using

    • tree --charset=ascii -n

  • README.md can be rendered locally using

    • pandoc README.md | lynx -stdin
    • make view

SEE ALSO