Skip to content

Commit 7af64f2

Browse files
committed
adding change log updating for documentation releases.
1 parent 7bf7a67 commit 7af64f2

File tree

3 files changed

+123
-122
lines changed

3 files changed

+123
-122
lines changed

CHANGELOG.md

Lines changed: 121 additions & 115 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,127 @@ All notable changes to this project will be documented in this file.
44
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
55

66
## Latest Changes
7+
### <span style='color:blue'>Resilient Sink Addition</span> ([v0.13.1](https://github.com/devsetgo/devsetgo_lib/releases/tag/v0.13.1))
8+
9+
#### What's Changed
10+
* Adding Resiliency to Logging Config (#429) @devsetgo
11+
* pip(deps): bump mkdocs-print-site-plugin from 2.4.1 to 2.5.0 (#422) @dependabot
12+
* pip(deps): bump ruff from 0.4.5 to 0.4.7 (#420) @dependabot
13+
* pip(deps): bump autopep8 from 2.1.1 to 2.2.0 (#421) @dependabot
14+
* pip(deps): bump mkdocs-material from 9.5.24 to 9.5.25 (#423) @dependabot
15+
16+
17+
Published Date: 2024 July 20, 20:51
18+
19+
### <span style='color:blue'></span> ([v0.13.0-republish](https://github.com/devsetgo/devsetgo_lib/releases/tag/v0.13.0-republish))
20+
21+
#### What's Changed
22+
Republishing v0.13.0 for pypi.
23+
24+
25+
Published Date: 2024 May 26, 17:13
26+
27+
### <span style='color:blue'></span> ([v0.13.0](https://github.com/devsetgo/devsetgo_lib/releases/tag/v0.13.0))
28+
29+
#### What's Changed
30+
* Breaking Change: Removing Limit and Offset from read queries (#419) @devsetgo
31+
32+
33+
Published Date: 2024 May 26, 15:44
34+
35+
### <span style='color:blue'>Adding missing requirement</span> ([v0.12.4](https://github.com/devsetgo/devsetgo_lib/releases/tag/v0.12.4))
36+
37+
#### What's Changed
38+
* adding missing requirement (#417) @devsetgo
39+
40+
41+
Published Date: 2024 May 16, 14:40
42+
43+
### <span style='color:blue'>Adding Email Validation</span> ([v0.12.3](https://github.com/devsetgo/devsetgo_lib/releases/tag/v0.12.3))
44+
45+
#### What's Changed
46+
* bump to 0.12.3 (#416) @devsetgo
47+
* Add email validation capabilities (#415) @devsetgo
48+
* pip(deps): bump mkdocs-material from 9.5.20 to 9.5.21 (#414) @dependabot
49+
* pip(deps): bump ruff from 0.4.2 to 0.4.4 (#413) @dependabot
50+
* pip(deps): bump coverage-badge from 1.1.0 to 1.1.1 (#409) @dependabot
51+
* pip(deps): bump mkdocs-material from 9.5.18 to 9.5.20 (#408) @dependabot
52+
* pip(deps): bump mkdocstrings[python,shell] from 0.24.3 to 0.25.0 (#407) @dependabot
53+
* pip(deps): bump ruff from 0.4.1 to 0.4.2 (#410) @dependabot
54+
* pip(deps): bump tqdm from 4.66.2 to 4.66.3 (#412) @dependabot
55+
56+
57+
Published Date: 2024 May 16, 14:19
58+
59+
### <span style='color:blue'>logging changes</span> ([v0.12.2](https://github.com/devsetgo/devsetgo_lib/releases/tag/v0.12.2))
60+
61+
#### What's Changed
62+
* Logging Changes, Documentation Updates, Using Ruff (#406) @devsetgo
63+
64+
65+
Published Date: 2024 April 22, 16:17
66+
67+
### <span style='color:blue'>Updates for MetaData and All HTTP Codes</span> ([v0.12.1](https://github.com/devsetgo/devsetgo_lib/releases/tag/v0.12.1))
68+
69+
#### What's Changed
70+
* Enhancements and fixes (#405) @devsetgo
71+
72+
73+
Published Date: 2024 April 19, 18:52
74+
75+
### <span style='color:blue'>Breaking Change: Base Schema per Database Type</span> ([v0.12.0](https://github.com/devsetgo/devsetgo_lib/releases/tag/v0.12.0))
76+
77+
#### What's Changed
78+
* Adding new base schema for database types (#402) @devsetgo
79+
* creating main release for 0.11.2 (#390) @devsetgo
80+
* Working on bug in read_query (#389) @devsetgo
81+
* Reorganizing Library Structure (#388) @devsetgo
82+
* Python Build and Publish fix (#382) @devsetgo
83+
84+
####
85+
Breaking Change - SchemaBase is now SchemaBaseSQLite
86+
87+
Published Date: 2024 April 13, 22:55
88+
89+
### <span style='color:blue'>Reorganizing Library Stucture</span> ([v0.11.2-main](https://github.com/devsetgo/devsetgo_lib/releases/tag/v0.11.2-main))
90+
91+
#### What's Changed
92+
* creating main release for 0.11.2 (#390) @devsetgo
93+
* Working on bug in read_query (#389) @devsetgo
94+
* Reorganizing Library Structure (#388) @devsetgo
95+
* Python Build and Publish fix (#382) @devsetgo
96+
97+
Breaking Changes are included in this release for import paths. See documents for more information.
98+
99+
Published Date: 2024 February 17, 19:09
100+
101+
### <span style='color:blue'>Read Query Fix Beta Testing</span> ([v0.11.2-beta1](https://github.com/devsetgo/devsetgo_lib/releases/tag/v0.11.2-beta1))
102+
103+
#### What's Changed
104+
* Working on bug in read_query (#389) @devsetgo
105+
* Reorganizing Library Structure (#388) @devsetgo
106+
* Python Build and Publish fix (#382) @devsetgo
107+
108+
109+
Published Date: 2024 February 16, 22:01
110+
111+
### <span style='color:blue'>Pre-Release to test new structure and publishing</span> ([v0.11.2-beta](https://github.com/devsetgo/devsetgo_lib/releases/tag/v0.11.2-beta))
112+
113+
#### What's Changed
114+
* Reorganizing Library Structure (#388) @devsetgo
115+
* Python Build and Publish fix (#382) @devsetgo
116+
117+
118+
Published Date: 2024 February 10, 21:16
119+
120+
### <span style='color:blue'></span> ([v0.11.2-fix2](https://github.com/devsetgo/devsetgo_lib/releases/tag/v0.11.2-fix2))
121+
122+
#### What's Changed
123+
* Python Build and Publish fix (#382) @devsetgo
124+
125+
126+
Published Date: 2024 January 21, 15:01
127+
7128
### <span style='color:blue'>Adding Delete Many and minor fixes</span> ([v0.11.2](https://github.com/devsetgo/devsetgo_lib/releases/tag/v0.11.2))
8129

9130
#### What's Changed
@@ -604,118 +725,3 @@ Published Date: 2021 March 18, 17:19
604725

605726

606727
Published Date: 2021 March 18, 17:06
607-
608-
### <span style='color:blue'>Minor updates and library updates.</span> ([v0.4.1](https://github.com/devsetgo/devsetgo_lib/releases/tag/v0.4.1))
609-
610-
# What's Changed
611-
* Updates and Minor updates (#78) @devsetgo
612-
* Bump tqdm from 4.54.1 to 4.55.0 (#77) @dependabot
613-
* Bump twine from 3.2.0 to 3.3.0 (#76) @dependabot
614-
* Bump coverage from 5.3 to 5.3.1 (#74) @dependabot
615-
* Bump mkdocs-material from 6.1.7 to 6.2.2 (#75) @dependabot
616-
* Bump watchdog from 0.10.4 to 1.0.2 (#73) @dependabot
617-
* Bump pytest from 6.1.2 to 6.2.1 (#71) @dependabot
618-
* Bump wheel from 0.36.1 to 0.36.2 (#70) @dependabot
619-
* Bump tqdm from 4.54.0 to 4.54.1 (#67) @dependabot
620-
* Bump mkdocs-material from 6.1.6 to 6.1.7 (#68) @dependabot
621-
* Bump pre-commit from 2.9.2 to 2.9.3 (#69) @dependabot
622-
* Bump wheel from 0.36.0 to 0.36.1 (#66) @dependabot
623-
* Bump wheel from 0.35.1 to 0.36.0 (#64) @dependabot
624-
* Bump tqdm from 4.53.0 to 4.54.0 (#65) @dependabot
625-
* Bump pre-commit from 2.8.2 to 2.9.2 (#61) @dependabot
626-
* Bump mkdocs-material from 6.1.5 to 6.1.6 (#60) @dependabot
627-
* Bump tqdm from 4.52.0 to 4.53.0 (#62) @dependabot
628-
* Bump watchdog from 0.10.3 to 0.10.4 (#63) @dependabot
629-
* Bump tqdm from 4.51.0 to 4.52.0 (#59) @dependabot
630-
* Bump mkdocs-material from 6.1.4 to 6.1.5 (#58) @dependabot
631-
* Bump mkdocs-material from 6.1.2 to 6.1.4 (#57) @dependabot
632-
* Bump pre-commit from 2.8.0 to 2.8.2 (#55) @dependabot
633-
* Bump mkdocs-material from 6.1.0 to 6.1.2 (#56) @dependabot
634-
* Bump pytest from 6.1.1 to 6.1.2 (#52) @dependabot
635-
* Bump pre-commit from 2.7.1 to 2.8.0 (#53) @dependabot
636-
* Bump tqdm from 4.50.2 to 4.51.0 (#54) @dependabot
637-
* Bump mkdocs-material from 6.0.2 to 6.1.0 (#51) @dependabot
638-
* Bump tqdm from 4.50.1 to 4.50.2 (#49) @dependabot
639-
* Bump tox from 3.20.0 to 3.20.1 (#50) @dependabot
640-
* Bump pytest from 6.1.0 to 6.1.1 (#48) @dependabot
641-
* Bump mkdocs-material from 6.0.1 to 6.0.2 (#47) @dependabot
642-
* Bump flake8 from 3.8.3 to 3.8.4 (#45) @dependabot
643-
* Bump tqdm from 4.50.0 to 4.50.1 (#44) @dependabot
644-
* Bump bump2version from 1.0.0 to 1.0.1 (#46) @dependabot
645-
* Bump tqdm from 4.49.0 to 4.50.0 (#42) @dependabot
646-
* Bump black from 19.10b0 to 20.8b1 (#43) @dependabot
647-
* Bump tqdm from 4.46.0 to 4.49.0 (#40) @dependabot
648-
* Bump pytest from 5.4.2 to 6.1.0 (#39) @dependabot
649-
* Bump coverage from 5.1 to 5.3 (#38) @dependabot
650-
* Bump autoflake from 1.3.1 to 1.4 (#41) @dependabot
651-
* Bump twine from 3.1.1 to 3.2.0 (#37) @dependabot
652-
* Bump wheel from 0.34.2 to 0.35.1 (#34) @dependabot
653-
* Bump pytest-cov from 2.9.0 to 2.10.1 (#36) @dependabot
654-
* Bump watchdog from 0.10.2 to 0.10.3 (#35) @dependabot
655-
* Bump mkdocs-material from 5.2.2 to 6.0.1 (#33) @dependabot
656-
* Bump pylint from 2.5.2 to 2.6.0 (#32) @dependabot-preview
657-
* Bump pre-commit from 2.4.0 to 2.7.1 (#31) @dependabot-preview
658-
* Bump tox from 3.15.1 to 3.20.0 (#30) @dependabot-preview
659-
* Bump flake8 from 3.8.2 to 3.8.3 (#29) @dependabot-preview
660-
* Bump autopep8 from 1.5.2 to 1.5.4 (#28) @dependabot-preview
661-
662-
663-
Published Date: 2020 December 26, 23:51
664-
665-
### <span style='color:blue'>0.4.0 - save_csv options</span> ([v0.4.0](https://github.com/devsetgo/devsetgo_lib/releases/tag/v0.4.0))
666-
667-
## [0.4.0] - Examples and Data
668-
### Added
669-
- skipping version 0.3.0 and adding to 0.4.0
670-
- Adding delimiter option to save_csv
671-
- Tests to check if delimiter > 1 character
672-
- set ',' if none
673-
- Adding quotechar option to save_csv
674-
- Tests to check if quotechar > 1 character
675-
- set '"' if none
676-
- Add test of non-list to save_csv
677-
678-
## [0.3.0] - Examples and Data
679-
### Added
680-
- Adding examples (see examples folder)
681-
- Adding file_function documentation
682-
- Adding documents site - https://devsetgo.github.io/devsetgo_lib/
683-
684-
685-
Published Date: 2020 April 16, 21:54
686-
687-
### <span style='color:blue'>Improvements</span> ([v0.2.0](https://github.com/devsetgo/devsetgo_lib/releases/tag/v0.2.0))
688-
689-
- Improved Tests
690-
- Improved Errors
691-
- Adding more logging
692-
693-
Published Date: 2020 January 26, 21:08
694-
695-
### <span style='color:blue'>v0.1.1</span> ([v0.1.1](https://github.com/devsetgo/devsetgo_lib/releases/tag/v0.1.1))
696-
697-
- New documentation
698-
- fixes to pypi deployment
699-
700-
701-
702-
703-
Published Date: 2020 January 26, 17:26
704-
705-
### <span style='color:blue'>Beta Release</span> ([v0.1.0b2](https://github.com/devsetgo/devsetgo_lib/releases/tag/v0.1.0b2))
706-
707-
Basic Function (file and folder)
708-
Publish to PyPi (fixing PyPi publishing issues)
709-
Needs documentation.
710-
711-
712-
Published Date: 2020 January 26, 13:03
713-
714-
### <span style='color:blue'>Pypi Beta Release</span> ([v0.1.0b](https://github.com/devsetgo/devsetgo_lib/releases/tag/v0.1.0b))
715-
716-
Change to semantic versioning
717-
- Publish to Pypi
718-
- Base Functions
719-
720-
721-
Published Date: 2020 January 26, 12:53

docs/index.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,19 +10,16 @@ Support Python Versions
1010
![Static Badge](https://img.shields.io/badge/Python-3.12%20%7C%203.11%20%7C%203.10%20%7C%203.9-blue)
1111
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
1212

13-
1413
CI/CD Pipeline:
1514

1615
[![Testing - Main](https://github.com/devsetgo/devsetgo_lib/actions/workflows/testing.yml/badge.svg?branch=main)](https://github.com/devsetgo/devsetgo_lib/actions/workflows/testing.yml)
1716
[![Testing - Dev](https://github.com/devsetgo/devsetgo_lib/actions/workflows/testing.yml/badge.svg?branch=dev)](https://github.com/devsetgo/devsetgo_lib/actions/workflows/testing.yml)
1817

19-
2018
SonarCloud:
2119

2220
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=devsetgo_devsetgo_lib&metric=coverage)](https://sonarcloud.io/dashboard?id=devsetgo_devsetgo_lib)
2321
[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=devsetgo_devsetgo_lib&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=devsetgo_devsetgo_lib)
2422
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=devsetgo_devsetgo_lib&metric=alert_status)](https://sonarcloud.io/dashboard?id=devsetgo_devsetgo_lib)
25-
2623
[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=devsetgo_devsetgo_lib&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=devsetgo_devsetgo_lib)
2724
[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=devsetgo_devsetgo_lib&metric=vulnerabilities)](https://sonarcloud.io/dashboard?id=devsetgo_devsetgo_lib)
2825

@@ -118,7 +115,3 @@ This project is licensed under the MIT License. See the [LICENSE](LICENSE) file
118115
## Contact
119116

120117
For any questions or issues, please open an issue on GitHub or contact us at [devsetgo@example.com](mailto:devsetgo@example.com).
121-
122-
---
123-
124-
This updated README provides a clear and concise overview of the library's capabilities and how to get started with it. Feel free to adjust the example code and other details as needed to better fit your library's specific features.

makefile

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,12 +40,14 @@ bump-patch: ## Bump the patch version number x.x.1
4040
cleanup: ruff autoflake flake8 ## Run ruff, autoflake, and flake8 to clean up and format Python code
4141

4242
create-docs: ## Build and deploy the project's documentation
43+
python3 scripts/changelog.py
4344
mkdocs build
4445
cp /workspaces/devsetgo_lib/README.md /workspaces/devsetgo_lib/docs/index.md
4546
cp /workspaces/devsetgo_lib/CONTRIBUTING.md /workspaces/devsetgo_lib/docs/contribute.md
4647
mkdocs gh-deploy
4748

4849
create-docs-local: ## Build and deploy the project's documentation
50+
python3 scripts/changelog.py
4951
mkdocs build
5052
cp /workspaces/devsetgo_lib/README.md /workspaces/devsetgo_lib/docs/index.md
5153
cp /workspaces/devsetgo_lib/CONTRIBUTING.md /workspaces/devsetgo_lib/docs/contribute.md

0 commit comments

Comments
 (0)