Gitiles
Code Review Sign In
gerrit.opencord.org / onf-make / f22de9dea0501064e0a588bf18879de7027791c4
commitf22de9dea0501064e0a588bf18879de7027791c4[log] [tgz]
authorJoey Armstrong <jarmstrong@linuxfoundation.org>Fri Apr 26 11:37:52 2024 -0400
committerJoey Armstrong <jarmstrong@linuxfoundation.org>Fri Apr 26 12:46:42 2024 -0400
treeae9b94d4cc29104c3d22f15c9db904879aa6ccc3
parent6f046d073c74f4f74bca1c5d3fe5da9f8d9860b7 [diff]
[VOL-5297] Add more pre-commit linters.

.pre-commit-config.yaml
-----------------------
  o Document where the latest config file can be copied from.
  o [todo] install this as a git submodule -- lf/pre-commit.

bin/setup.sh
------------
  o Greatly simplify the installer.
  o No longer need to preserve makefiles/ when transitioning.
  o Git submodule installed into lf/onf-make/ so simply
    mkdir and git submodule <path>.

Makefile
--------
  o Added convenience makefile target view used to
    pre-screening README.md markdown edits before publishing
    to the repository for final rendering/browser viewing.

Signed-off-by: Joey Armstrong <jarmstrong@linuxfoundation.org>
Change-Id: I946336e37253be2a6f675ed47c01005edf27c1ab
4 files changed
tree: ae9b94d4cc29104c3d22f15c9db904879aa6ccc3
  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. install/
  12. makefiles/
  13. makefiles_include_mk.ex
  14. 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:

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