Gitiles
Code Review Sign In
gerrit.opencord.org / onf-make / 9d0f1acad52a49d403bc75eac9ca4d35bf7a8ee1
commit9d0f1acad52a49d403bc75eac9ca4d35bf7a8ee1[log] [tgz]
authorJoey Armstrong <jarmstrong@linuxfoundation.org>Wed Apr 03 16:12:49 2024 -0400
committerJoey Armstrong <joey@opennetworking.org>Fri Apr 05 14:19:23 2024 +0000
treebd5eaab3bd2835af23d04cbbb28e47e70de7957d
parentf2f0a3fde5705e253c306ca081948c1df73a487d [diff]
feature: add command pre-commit

makefiles/commands/pre-commit/
makefiles/commands/pre-commit/install.mk
makefiles/commands/pre-commit/pre-commit.mk
makefiles/commands/pre-commit/requirements.txt
----------------------------------------------
  o Add module and make dependencies to install command pre-commit.

Signed-off-by: Joey Armstrong <jarmstrong@linuxfoundation.org>
Change-Id: I9e9601dde4db29a32b8a09091c445f2c26bb9b13
6 files changed
tree: bd5eaab3bd2835af23d04cbbb28e47e70de7957d
  1. .gitignore
  2. .gitreview
  3. .pre-commit-config.yaml
  4. .reuse/
  5. LICENSES/
  6. Makefile
  7. README.md
  8. bin/
  9. config.mk
  10. docs/
  11. makefiles/
  12. makefiles_include_mk.ex
  13. requirements.txt
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

-----------------------------------------------------------------------

Copyright 2023-2024 Open Networking Foundation Contributors

Licensed under the Apache License, Version 2.0 (the "License");

you may not use this file except in compliance with the License.

You may obtain a copy of the License at

http:#www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software

distributed under the License is distributed on an "AS IS" BASIS,

WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

See the License for the specific language governing permissions and

limitations under the License.

-----------------------------------------------------------------------

SPDX-FileCopyrightText: 2023-2024 Open Networking Foundation Contributors

SPDX-License-Identifier: Apache-2.0

-----------------------------------------------------------------------

Intent:

-----------------------------------------------------------------------