Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
74 commits
Select commit Hold shift + click to select a range
7fbdedd
OSRB docs review, first pass
progala Jul 21, 2022
78273c9
Merge branch 'lvrfrc87' into docs-review
lvrfrc87 Jul 26, 2022
a3a355d
Merge branch 'develop' into docs-review
lvrfrc87 Jul 26, 2022
95f50b6
Merge branch 'main' into docs-review
lvrfrc87 Jul 29, 2022
ee9abee
readme updates
scetron Jul 29, 2022
f9a6c6e
migrate get_value method into function and rename
lvrfrc87 Jul 29, 2022
2e2363f
Merge branch 'docs-review' of github.com:networktocode-llc/netcompare…
lvrfrc87 Jul 29, 2022
c9600d9
updates
scetron Jul 29, 2022
4966f04
Merge branches 'docs-review' and 'docs-review' of https://github.com/…
scetron Jul 29, 2022
2d67a40
updates
scetron Jul 29, 2022
163424f
edits
scetron Jul 29, 2022
25383ef
update evaluate signature for check method
lvrfrc87 Aug 1, 2022
12c2b9c
Merge branch 'docs-review' of github.com:networktocode-llc/netcompare…
lvrfrc87 Aug 1, 2022
42c349a
Update readme
scetron Aug 9, 2022
d6302d4
Update README.md
scetron Aug 9, 2022
8b7f78c
Update README.md
scetron Aug 9, 2022
83fb2cb
Update README.md
scetron Aug 9, 2022
f7921c5
Update README.md
scetron Aug 9, 2022
f88d414
Update README.md
lvrfrc87 Aug 12, 2022
b17daa8
Update README.md
lvrfrc87 Aug 12, 2022
c78af66
Update README.md
lvrfrc87 Aug 12, 2022
aa96d5e
Update README.md
lvrfrc87 Aug 12, 2022
2a98b99
Update README.md
lvrfrc87 Aug 12, 2022
557b7d9
Update README.md
lvrfrc87 Aug 12, 2022
27023d0
Update README.md
lvrfrc87 Aug 12, 2022
f58f020
Update README.md
lvrfrc87 Aug 12, 2022
1cbfe60
Update README.md
lvrfrc87 Aug 12, 2022
4a91e4b
Update README.md
lvrfrc87 Aug 12, 2022
b065dff
Update README.md
lvrfrc87 Aug 12, 2022
7267441
Update README.md
lvrfrc87 Aug 12, 2022
07d30eb
Update README.md
lvrfrc87 Aug 12, 2022
3f2da46
Update README.md
lvrfrc87 Aug 12, 2022
1b106e7
Update README.md
lvrfrc87 Aug 12, 2022
076aa90
initial add mkdocs
scetron Aug 13, 2022
e0e7be0
updates
scetron Aug 13, 2022
c878465
Update README.md
dwight525 Aug 16, 2022
26fcaa4
Update usage.md
dwight525 Aug 17, 2022
a37e384
Update architecture.md
dwight525 Aug 17, 2022
1e0f844
Update index.md
dwight525 Aug 17, 2022
4289f41
Merge pull request #77 from dwight525/patch-4. Index.md doc edits.
scetron Aug 18, 2022
bc05a15
Merge pull request #76 from dwight525/patch-3
scetron Aug 18, 2022
e47a5df
Merge pull request #75 from dwight525/patch-2
scetron Aug 18, 2022
930f2b6
Merge pull request #74 from dwight525/patch-1
scetron Aug 18, 2022
dc8b0c5
updates
scetron Aug 23, 2022
a0969ab
Update extract_data_from_json
scetron Aug 23, 2022
52a784b
update readme suggestions
scetron Aug 23, 2022
e83833a
update mkdocs
scetron Aug 23, 2022
7e6ea96
remove comment
scetron Aug 23, 2022
8748393
few more edits
scetron Aug 23, 2022
b3a31db
replace output arg with data
lvrfrc87 Aug 24, 2022
6cfb0a4
fix tests
lvrfrc87 Aug 24, 2022
e1e72d9
Update README.md
progala Aug 24, 2022
989945e
doc updates from review
scetron Aug 24, 2022
da13fc6
Merge branch 'docs-review' of https://github.com/networktocode-llc/ne…
scetron Aug 24, 2022
c623920
not-range to not-in-range
scetron Aug 24, 2022
bf546d7
update/check usage examples
scetron Aug 25, 2022
451cb18
add workflow summary to usage
scetron Aug 25, 2022
eb8eaf7
update arch examples
scetron Aug 25, 2022
a341561
Update docs/usage.md
progala Aug 26, 2022
55672ed
Update docs/usage.md
progala Aug 26, 2022
a6bcff3
Update docs/usage.md
progala Aug 26, 2022
01a17e0
Update docs/usage.md
progala Aug 26, 2022
3dc349e
Update docs/usage.md
progala Aug 26, 2022
278bb38
update architecture image
scetron Aug 26, 2022
2dff682
fix links
scetron Aug 26, 2022
d3a569a
Update docs/index.md
progala Aug 26, 2022
a4e9eb3
edits
scetron Aug 26, 2022
97817f3
update netcompare -> jdiff
scetron Aug 30, 2022
f70f683
Merge pull request #68 from networktocode-llc/docs-review
scetron Aug 31, 2022
87d260d
Update the GHA workflow (#78)
ubajze Sep 1, 2022
701228c
Create requirements.txt
ubajze Sep 1, 2022
40fb64b
Release 0.0.1
Sep 1, 2022
f45f899
Merge pull request #80 from networktocode/release-v0.0.1
Sep 1, 2022
916129c
Update mkdocs settings (#81)
ubajze Sep 1, 2022
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
140 changes: 50 additions & 90 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
---
name: "CI"
on: # yamllint disable-line rule:truthy rule:comments
- "push"
- "pull_request"

env:
IMAGE_NAME: "jdiff"
push:
branches:
- "main"
- "develop"
tags:
- "v*"
pull_request: ~

jobs:
black:
Expand Down Expand Up @@ -41,8 +43,6 @@ jobs:
uses: "networktocode/gh-action-setup-poetry-environment@v2"
- name: "Linting: bandit"
run: "poetry run invoke bandit"
needs:
- "black"
pydocstyle:
runs-on: "ubuntu-20.04"
env:
Expand All @@ -54,8 +54,6 @@ jobs:
uses: "networktocode/gh-action-setup-poetry-environment@v2"
- name: "Linting: pydocstyle"
run: "poetry run invoke pydocstyle"
needs:
- "black"
flake8:
runs-on: "ubuntu-20.04"
env:
Expand All @@ -67,8 +65,6 @@ jobs:
uses: "networktocode/gh-action-setup-poetry-environment@v2"
- name: "Linting: flake8"
run: "poetry run invoke flake8"
needs:
- "black"
yamllint:
runs-on: "ubuntu-20.04"
env:
Expand All @@ -80,44 +76,14 @@ jobs:
uses: "networktocode/gh-action-setup-poetry-environment@v2"
- name: "Linting: yamllint"
run: "poetry run invoke yamllint"
needs:
- "black"
build:
strategy:
fail-fast: true
matrix:
python-version: ["3.7", "3.8", "3.9", "3.10"]
runs-on: "ubuntu-20.04"
env:
PYTHON_VER: "${{ matrix.python-version }}"
steps:
- name: "Check out repository code"
uses: "actions/checkout@v2"
- name: "Setup environment"
uses: "networktocode/gh-action-setup-poetry-environment@v2"
- name: "Get image version"
run: "echo IMAGE_VER=`poetry version -s`-py${{ matrix.python-version }} >> $GITHUB_ENV"
- name: "Set up Docker Buildx"
id: "buildx"
uses: "docker/setup-buildx-action@v1"
- name: "Build"
uses: "docker/build-push-action@v2"
with:
builder: "${{ steps.buildx.outputs.name }}"
context: "./"
push: false
tags: "${{ env.IMAGE_NAME }}:${{ env.IMAGE_VER }}"
file: "./Dockerfile"
cache-from: "type=gha,scope=${{ env.IMAGE_NAME }}-${{ env.IMAGE_VER }}-py${{ matrix.python-version }}"
cache-to: "type=gha,scope=${{ env.IMAGE_NAME }}-${{ env.IMAGE_VER }}-py${{ matrix.python-version }}"
build-args: |
PYTHON_VER=${{ env.PYTHON_VER }}
pylint:
needs:
- "bandit"
- "pydocstyle"
- "flake8"
- "yamllint"
pylint:
- "black"
- "mypy"
runs-on: "ubuntu-20.04"
strategy:
fail-fast: true
Expand All @@ -131,31 +97,11 @@ jobs:
uses: "actions/checkout@v2"
- name: "Setup environment"
uses: "networktocode/gh-action-setup-poetry-environment@v2"
- name: "Get image version"
run: "echo IMAGE_VER=`poetry version -s`-py${{ matrix.python-version }} >> $GITHUB_ENV"
- name: "Set up Docker Buildx"
id: "buildx"
uses: "docker/setup-buildx-action@v1"
- name: "Load the image from cache"
uses: "docker/build-push-action@v2"
with:
builder: "${{ steps.buildx.outputs.name }}"
context: "./"
push: false
load: true
tags: "${{ env.IMAGE_NAME }}:${{ env.IMAGE_VER }}"
file: "./Dockerfile"
cache-from: "type=gha,scope=${{ env.IMAGE_NAME }}-${{ env.IMAGE_VER }}-py${{ matrix.python-version }}"
cache-to: "type=gha,scope=${{ env.IMAGE_NAME }}-${{ env.IMAGE_VER }}-py${{ matrix.python-version }}"
build-args: |
PYTHON_VER=${{ env.PYTHON_VER }}
- name: "Debug: Show docker images"
run: "docker image ls"
- name: "Linting: Pylint"
run: "poetry run invoke pylint"
needs:
- "build"
pytest:
needs:
- "pylint"
strategy:
fail-fast: true
matrix:
Expand All @@ -169,31 +115,11 @@ jobs:
uses: "actions/checkout@v2"
- name: "Setup environment"
uses: "networktocode/gh-action-setup-poetry-environment@v2"
- name: "Get image version"
run: "echo IMAGE_VER=`poetry version -s`-py${{ matrix.python-version }} >> $GITHUB_ENV"
- name: "Set up Docker Buildx"
id: "buildx"
uses: "docker/setup-buildx-action@v1"
- name: "Load the image from cache"
uses: "docker/build-push-action@v2"
with:
builder: "${{ steps.buildx.outputs.name }}"
context: "./"
push: false
load: true
tags: "${{ env.IMAGE_NAME }}:${{ env.IMAGE_VER }}"
file: "./Dockerfile"
cache-from: "type=gha,scope=${{ env.IMAGE_NAME }}-${{ env.IMAGE_VER }}-py${{ matrix.python-version }}"
cache-to: "type=gha,scope=${{ env.IMAGE_NAME }}-${{ env.IMAGE_VER }}-py${{ matrix.python-version }}"
build-args: |
PYTHON_VER=${{ env.PYTHON_VER }}
- name: "Debug: Show docker images"
run: "docker image ls"
- name: "Run Tests"
run: "poetry run invoke pytest"
needs:
- "pylint"
publish_gh:
needs:
- "pytest"
name: "Publish to GitHub"
runs-on: "ubuntu-20.04"
if: "startsWith(github.ref, 'refs/tags/v')"
Expand All @@ -220,9 +146,9 @@ jobs:
tag: "${{ github.ref }}"
overwrite: true
file_glob: true
publish_pypi:
needs:
- "pytest"
publish_pypi:
name: "Push Package to PyPI"
runs-on: "ubuntu-20.04"
if: "startsWith(github.ref, 'refs/tags/v')"
Expand All @@ -248,5 +174,39 @@ jobs:
password: "${{ secrets.PYPI_API_TOKEN }}"
# Using PyPi dev.
repository_url: "https://test.pypi.org/legacy/"
slack-notify:
needs:
- "pytest"
- "publish_gh"
- "publish_pypi"
name: "Send notification to the Slack"
runs-on: "ubuntu-20.04"
env:
SLACK_WEBHOOK_URL: "${{ secrets.SLACK_WEBHOOK_URL }}"
SLACK_MESSAGE: >-
*NOTIFICATION: NEW-RELEASE-PUBLISHED*\n
Repository: <${{ github.server_url }}/${{ github.repository }}|${{ github.repository }}>\n
Release: <${{ github.server_url }}/${{ github.repository }}/releases/tag/${{ github.ref_name }}|${{ github.ref_name }}>\n
Published by: <${{ github.server_url }}/${{ github.actor }}|${{ github.actor }}>
steps:
- name: "Send a notification to Slack"
# ENVs cannot be used directly in job.if. This is a workaround to check
# if SLACK_WEBHOOK_URL is present.
if: "${{ env.SLACK_WEBHOOK_URL != '' }}"
uses: "slackapi/slack-github-action@v1.17.0"
with:
payload: |
{
"text": "${{ env.SLACK_MESSAGE }}",
"blocks": [
{
"type": "section",
"text": {
"type": "mrkdwn",
"text": "${{ env.SLACK_MESSAGE }}"
}
}
]
}
env:
SLACK_WEBHOOK_URL: "${{ secrets.SLACK_WEBHOOK_URL }}"
SLACK_WEBHOOK_TYPE: "INCOMING_WEBHOOK"
Loading