Skip to content

Commit

Permalink
Update README.md and continuous deployment
Browse files Browse the repository at this point in the history
  • Loading branch information
douglaslassance committed Feb 10, 2024
1 parent 050e4ca commit a89eb58
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 10 deletions.
11 changes: 5 additions & 6 deletions .github/workflows/cd.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@ name: CD

on:
release:
types: [created]
types: [ created ]

jobs:
deploy:
name: Deploy
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v2
uses: actions/setup-python@v5
with:
python-version: "3.x"
- name: Install dependencies
Expand All @@ -20,8 +20,7 @@ jobs:
pip install setuptools wheel twine
- name: Publish on PyPI
env:
TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
TWINE_PASSWORD: ${{ secrets.TWINE_PASSWORD }}
run: |
python setup.py sdist bdist_wheel
twine upload --verbose dist/*
twine upload --username __token__ --verbose dist/*
22 changes: 18 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -229,15 +229,29 @@ mkvirtualenv gitalong
pip install --editable .[ci]
```

Run tests using:
### Testing

```python
pytest --cov-report=html --cov=gitalong --profile-svg
pytest - -cov - report = html - -cov = gitalong - -profile - svg
```

Build docs using:
### Documenting

```shell
sphinx-build ./docs/source ./docs/build
```

### Building

```shell
python setup.py sdist bdist_wheel
```

### Publishing

```shell
twine upload --username __token__ --verbose dist/*
```

As a bonus, build systems for installing requirements and running tests are on board the provided Sublime Text project and can be accessed using <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>B</kbd>.
As a bonus, build systems for installing requirements and running tests are on board the provided Sublime Text project
and can be accessed using <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>B</kbd>.
3 changes: 3 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,13 @@
"pytest-html~=4.1",
"pytest-profiling~=1.7",
"responses~=0.24",
"setuptools~=69.0",
"sphinx-markdown-tables~=0.0",
"sphinx-rtd-theme~=2.0",
"sphinxcontrib-apidoc~=0.5",
"Sphinx~=7.2",
"twine~=4.0",
"wheel~=0.42",
],
},
entry_points={
Expand Down

0 comments on commit a89eb58

Please sign in to comment.