Skip to content

Commit 5a32eb9

Browse files
committed
docs: updated writeups
1 parent 323257a commit 5a32eb9

File tree

8 files changed

+189
-256
lines changed

8 files changed

+189
-256
lines changed

.github/workflows/testpypi.yml

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
name: CD - Publish to TestPyPI
2+
3+
on:
4+
workflow_run:
5+
workflows: ["CI - Run Tox Tests"]
6+
types:
7+
- completed
8+
9+
jobs:
10+
build:
11+
name: Build distribution
12+
runs-on: ubuntu-latest
13+
14+
if: ${{ github.event.workflow_run.conclusion == 'success' }}
15+
16+
strategy:
17+
matrix:
18+
python-version: ["3.10", "3.11", "3.12", "3.13"]
19+
20+
steps:
21+
- uses: actions/checkout@v4
22+
- name: Set up Python
23+
uses: actions/setup-python@v5
24+
with:
25+
python-version: ${{ matrix.python-version }}
26+
- name: Install pypa/build
27+
run: python3 -m pip install build --user
28+
- name: Build a binary wheel and a source tarball
29+
run: python3 -m build
30+
- name: Upload the distribution packages
31+
uses: actions/upload-artifact@v4
32+
with:
33+
name: dist-${{ matrix.python-version }}
34+
path: dist
35+
36+
publish-to-testpypi:
37+
name: Publish Python distribution to TestPyPI
38+
needs: build
39+
runs-on: ubuntu-latest
40+
41+
environment:
42+
name: testpypi
43+
url: https://test.pypi.org/p/fakernaija
44+
45+
permissions:
46+
id-token: write # Required for OIDC authentication
47+
48+
steps:
49+
- name: Download the distribution packages
50+
uses: actions/download-artifact@v4
51+
with:
52+
pattern: dist-*
53+
merge-multiple: true
54+
path: dist
55+
- name: Publish distribution to TestPyPI
56+
uses: pypa/gh-action-pypi-publish@release/v1
57+
with:
58+
repository-url: https://test.pypi.org/legacy/

.pre-commit-config.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
repos:
22
- repo: https://github.com/pre-commit/pre-commit-hooks
3-
rev: v4.6.0
3+
rev: v5.0.0
44
hooks:
55
- id: check-added-large-files
66
- id: check-ast
@@ -16,12 +16,12 @@ repos:
1616
- id: mixed-line-ending
1717
- id: requirements-txt-fixer
1818
- repo: https://github.com/astral-sh/ruff-pre-commit
19-
rev: v0.6.2
19+
rev: v0.11.11
2020
hooks:
2121
- id: ruff
2222
args: [--fix, --exclude=docs/*]
2323
- id: ruff-format
2424
- repo: https://github.com/pre-commit/mirrors-mypy
25-
rev: v1.11.2
25+
rev: v1.15.0
2626
hooks:
2727
- id: mypy

docs/source/changelog.rst

Lines changed: 1 addition & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -6,34 +6,7 @@ All notable changes to this project will be documented in this file.
66
The changelog format is loosely based on `Keep a Changelog <https://keepachangelog.com/en/1.0.0/>`_,
77
and this project adheres to `Semantic Versioning <https://semver.org/spec/v2.0.0.html>`_.
88

9-
[Unreleased]
10-
------------
11-
12-
**Added:**
13-
14-
- for new features.
15-
16-
**Changed:**
17-
18-
- for changes in existing functionality.
19-
20-
**Deprecated:**
21-
22-
- for soon-to-be removed features.
23-
24-
**Removed:**
25-
26-
- for now removed features.
27-
28-
**Fixed:**
29-
30-
- for any bug fixes.
31-
32-
**Security:**
33-
34-
- in case of vulnerabilities.
35-
36-
[1.0.0] - Aso Agbada
9+
[0.1.0] - Aso Agbada
3710
--------------------
3811

3912
**Added:**

0 commit comments

Comments
 (0)