Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/apache/openwhisk-utilities
Shared utilities used across Apache OpenWhisk project repositories.
https://github.com/apache/openwhisk-utilities
apache openwhisk
Last synced: 2 days ago
JSON representation
Shared utilities used across Apache OpenWhisk project repositories.
- Host: GitHub
- URL: https://github.com/apache/openwhisk-utilities
- Owner: apache
- License: apache-2.0
- Created: 2017-05-17T18:36:37.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-09-24T14:45:44.000Z (9 days ago)
- Last Synced: 2024-09-26T16:03:09.899Z (7 days ago)
- Topics: apache, openwhisk
- Language: Python
- Homepage: https://openwhisk.apache.org/
- Size: 130 KB
- Stars: 6
- Watchers: 32
- Forks: 15
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[](http://www.apache.org/licenses/LICENSE-2.0)
[](https://github.com/apache/openwhisk-utilities/actions/workflows/ci.yaml)
[](https://github.com/apache/openwhisk-utilities/actions/workflows/scancode.yaml)
# OpenWhisk Utilities
Shared utilities used across Apache OpenWhisk project repositories.
### Utility listing
The following utilities are included in this repository (by subdirectory):
- _**scancode**_ - Configurable code scanning utility that performs file and line-level checks on all files (exclusions permitted) on a provided path. It is intended for Git commit hooks and continuous integration (CI) builds to enforce certain coding conventions.
If you "push" code that follows all conventions, you will see the message:
```bash
Scanning files starting at [./mycodepath/]...
All checks passed.
```
However, if you push code containing tabs, trailing whitespace or missing Apache License headers, your build will fail immediately with one of the following messages:
```bash
Scan detected 3 error(s) in 1 file(s):
[./mycodepath/sourcecode.go]:
1: file does not include required license header.
18: line contains tabs.
27: line has trailing whitespaces.
```
To make sure this never happens to you, you can run the same tests on your local machine every time you commit changes.
1. Clone the OpenWhisk utilities project:
```bash
$ git clone https://github.com/apache/openwhisk-utilities.git
```
2. Run the scancode utility against the root directory of your project or subdirectory where your code changes live:
```bash
$ python3 ./openwhisk-utilities/scancode/scanCode.py $ROOTDIR
```
It is worth adding a Git [pre-commit hook](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks) to automatically run the checks before you can even type in a Git commit message. Here is a sample `pre-commit` file:
```bash
$ cat /path/to/openwhisk/.git/hooks/pre-commit
#!/usr/bin/env bash
# -- Code scanning --
# See https://github.com/apache/openwhisk-utilities
# determine openwhisk base directory
root="$(git rev-parse --show-toplevel)"
scancode_path="/path/to/openwhisk-utilities/scancode"
python3 $scancode_path/scanCode.py --config $scancode_path/ASF-Release.cfg --gitignore $root/.gitignore $root
```
_Note_: A hook a locally installed, so if you check out the repository again, you will need to reinstall it.
Apache OpenWhisk repositories can be configured to run scancode as part of their CI process by invoking it
as a GitHub action. It should be run immediately after the checkout action. For example:
```yaml
# Checkout just this repo and run scanCode before we do anything else
- name: Checkout runtime repo
uses: actions/checkout@v3
- name: Scan Code
uses: apache/openwhisk-utilities/scancode@master
```
### Issues
Report bugs, ask questions and request features [here on GitHub](https://github.com/apache/openwhisk-utilities/issues).
You can also join our Slack channel and chat with developers. To get access to our Slack channel, request an invite [here](http://slack.openwhisk.org).