Skip to content

Commit

Permalink
chrore(trestle): Repo initialisation (#1)
Browse files Browse the repository at this point in the history
Migrating project from internal IBM github.
  • Loading branch information
aNebula authored Sep 10, 2020
1 parent 59e4db0 commit 7c9b92a
Show file tree
Hide file tree
Showing 64 changed files with 67,648 additions and 2 deletions.
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/proposed_change.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
___

## Instructions: REMOVE before creating issue

- Use this issue template to guide creation of issues. It is not required that all of the fields are filled our or used.

___

## Issue description / feature objectives

## Completion Criteria

## Expected Behavior

## Actual Behavior

## Steps to Reproduce the Problem

1.
1.
1.

## Specifications

- Version / branch:
- Platform:
- Subsystem:
40 changes: 40 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
## Types of changes

<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->

- \[ \] Bug fix (non-breaking change which fixes an issue)
- \[ \] New feature (non-breaking change which adds functionality)
- \[ \] Breaking change (fix or feature that would cause existing functionality to change)
- \[ \] My code follows the code style of this project.
- \[ \] My change requires a change to the documentation.
- \[ \] I have updated the documentation accordingly.
- \[ \] I have added tests to cover my changes.
- \[ \] All new and existing tests passed.

## Pull requests instructions

Please, go through these steps before you submit a PR.

1. Make sure that your PR is not a duplicate.

1. If not, then make sure that:

a. You have done your changes in a separate branch. Branches MUST have descriptive names that start with either the `fix/` or `feature/` prefixes. Good examples are: `fix/signin-issue` or `feature/issue-templates`.

b. You have a descriptive commit message with a short title (first line).

c. Please make sure that your branch passes tests before

1. **After** these steps, you're ready to open a pull request.

a. Your pull request MUST NOT target the `master` branch on this repository. You probably want to target `develop` instead.

b. Give a descriptive title to your PR.

c. Provide a description of your changes.

d. Put `closes #XXXX` in your comment to auto-close the issue that your PR fixes (if such).

e Link all other issues which the PR refers to if not closing an issue. At least one issue MUST be linked or close for a PR to be accepted.

**PLEASE REMOVE THESE INSTRUCTIONS BEFORE SUBMITTING**
54 changes: 54 additions & 0 deletions .github/workflows/python-test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
name: Trestle CI


on: [push, pull_request]

jobs:
build:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: [ 3.7, 3.8]

steps:
- uses: actions/checkout@v2
with:
submodules: true
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v2
with:
python-version: ${{ matrix.python-version }}
- name: Install build tools
run: |
make develop
- name: Install dependencies
run: |
make install
- name: Run code formatting (yapf)
run: |
make code-format
- name: Run code linting (flake8)
run: |
make code-lint
- name: Pytest
run: |
make test
- name: Push code-cov
uses: codecov/codecov-action@v1
with:
token: ${{ secrets.CODECOV_TOKEN }}
file: ./coverage.xml
deploy:
runs-on: ubuntu-latest
needs: build
if: github.ref == 'refs/heads/master'
steps:
- name: Create release
shell: bash
env:
PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
make release
24 changes: 24 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Binaries for programs and plugins
*.exe
*.exe~
*.dll
*.so
*.dylib
# Messy merges
*.orig
# Test binary, built with `go test -c`
*.test

# Output of the go coverage tool, specifically when used with LiteIDE
*.out

# Dependency directories (remove the comment below to include it)
# vendor/
venv
*.egg-info
.vscode/settings.json

_*/

#OS X
.DS_Store
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[submodule "nist-source"]
path = nist-source
url = https://github.com/usnistgov/OSCAL.git
42 changes: 42 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
repos:
- repo: https://github.com/pre-commit/mirrors-yapf
rev: v0.30.0
hooks:
- id: yapf
args: [--in-place, --parallel, --recursive, --style, .yapf-config]
files: "^(trestle|test)"
exclude: "oscal"
stages: [commit]
- repo: https://gitlab.com/pycqa/flake8
rev: 3.8.3
hooks:
- id: flake8
args: [
--extend-ignore,
"P1,C812,C813,C814,C815,C816,W503"
]
additional_dependencies: [
flake8-2020,
flake8-broken-line,
flake8-bugbear,
flake8-builtins,
flake8-commas,
flake8-comprehensions,
flake8-docstrings,
flake8-eradicate,
flake8-import-order,
flake8-mutable,
flake8-pep3101,
flake8-print,
flake8-quotes,
flake8-string-format,
flake8-use-fstring,
pep8-naming
]
files: "^(trestle|test)"
exclude: "oscal"
stages: [commit]
- repo: https://github.com/hukkinj1/mdformat
rev: 0.1.1 # Use the ref you want to point at
hooks:
- id: mdformat
14 changes: 14 additions & 0 deletions .yapf-config
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
[style]
based_on_style = facebook
align_closing_bracket_with_visual_indent = true
allow_split_before_dict_value = false
blank_line_before_nested_class_or_def = true
column_limit = 120
indent_dictionary_value = false
split_all_top_level_comma_separated_values = true
split_arguments_when_comma_terminated = true
split_before_arithmetic_operator = true
split_before_expression_after_opening_paren = true
split_before_first_argument = true
split_before_logical_operator = true
split_complex_comprehension = true
Loading

0 comments on commit 7c9b92a

Please sign in to comment.