Skip to content

feat: project documentation #173

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
cakeinsauce wants to merge 17 commits into
base: main
Choose a base branch
from
Open

feat: project documentation #173

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
6682c90
feat: project documentation
cakeinsauce Feb 7, 2023
80accee
fix: adjust to poetry rebase, fix conflicts, minor improvements
cakeinsauce Mar 22, 2023
33bbdce
fix: disable docs gen action
cakeinsauce Mar 22, 2023
c91b1d1
feat: add badgerdoc cli library
cakeinsauce Mar 26, 2023
02d98b6
fix: replace all services cli with badgerdoc
cakeinsauce Mar 30, 2023
8931e0c
feat: add badgerdoc_cli to python_base
cakeinsauce Mar 30, 2023
55ca671
fix: update gh actions
cakeinsauce Mar 30, 2023
50d833d
Merge remote-tracking branch 'origin/main' into feat/project-document…
cakeinsauce Mar 30, 2023
abf770d
fix: replace poetry add with pip install in docs GH actions
cakeinsauce Mar 30, 2023
599a70f
fix: versions
cakeinsauce Mar 30, 2023
23bd13b
feat(badgerdoc_cli): add tests and GH actions CI
cakeinsauce Mar 30, 2023
30ae1f3
feat: update readme
cakeinsauce Mar 30, 2023
4cc0835
fix: gh actions badgerdoc cli
cakeinsauce Mar 30, 2023
db64f14
feat: update docs
cakeinsauce Mar 31, 2023
07b6407
fix: adjust badgerdoc cli command
cakeinsauce Mar 31, 2023
4f6c018
fix: adjust gh actions badgerdoc cli
cakeinsauce Mar 31, 2023
e0374b0
fix: root ignore file
cakeinsauce Mar 31, 2023
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
1 change: 1 addition & 0 deletions .github/workflows/annotation.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ jobs:
poetry install --no-root
poetry add ../lib/filter_lib
poetry add ../lib/tenants
poetry add ../lib/badgerdoc_cli
poetry run alembic upgrade head
poetry run pytest
env:
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/assets.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ jobs:
poetry install --no-root --no-interaction
poetry add ../lib/filter_lib
poetry add ../lib/tenants
poetry add ../lib/badgerdoc_cli
- name: Test with pytest
run: |
cd assets
Expand Down
36 changes: 36 additions & 0 deletions .github/workflows/badgerdoc-cli.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: badgerdoc_cli linters and tests
on:
push:
paths:
- lib/badgerdoc_cli/**
- .github/worlflows/badgerdoc-cli.yml
pull_request:
paths:
- lib/badgerdoc_cli/**
- .github/worlflows/badgerdoc-cli.yml
jobs:
badgerdoc-cli-test:
strategy:
matrix:
python-version: [ "3.8.15" ]
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}
cache: 'pip'
- name: Install dependencies
working-directory: ./lib/badgerdoc_cli
run: |
python -m pip install --upgrade pip
pip install ".[dev]"
- name: Run linters and checkers [isort -> black -> mypy -> pylint]
working-directory: ./lib/badgerdoc_cli
run: |
git ls-files -- . | xargs pre-commit run --files
- name: Run tests
working-directory: ./lib/badgerdoc_cli
run: |
pytest tests/
Loading