Skip to content

Commit df80659

Browse files
btschwertfegerbtschwertfeger
authored
Create a Changelog (#21)
1 parent a60e877 commit df80659

File tree

5 files changed

+192
-65
lines changed

5 files changed

+192
-65
lines changed

‎.github/workflows/_codeql.yml

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
# For most projects, this workflow file will not need changing; you simply need
2+
# to commit it to your repository.
3+
#
4+
# You may wish to alter this file to override the set of languages analyzed,
5+
# or to provide custom queries or build logic.
6+
#
7+
# ******** NOTE ********
8+
# We have attempted to detect the languages in your repository. Please check
9+
# the `language` matrix defined below to confirm you have the correct set of
10+
# supported CodeQL languages.
11+
#
12+
13+
name: CodeQL
14+
15+
on:
16+
workflow_call:
17+
18+
jobs:
19+
analyze:
20+
name: Analyze
21+
runs-on: ubuntu-latest
22+
permissions:
23+
actions: read
24+
contents: read
25+
security-events: write
26+
27+
# strategy:
28+
# fail-fast: false
29+
# matrix:
30+
# language: ["python"]
31+
# CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
32+
# Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
33+
34+
steps:
35+
- name: Checkout repository
36+
uses: actions/checkout@v3
37+
38+
# Initializes the CodeQL tools for scanning.
39+
- name: Initialize CodeQL
40+
uses: github/codeql-action/init@v2
41+
with:
42+
languages: python
43+
# If you wish to specify custom queries, you can do so here or in a config file.
44+
# By default, queries listed here will override any specified in a config file.
45+
# Prefix the list here with "+" to use these queries and those in the config file.
46+
47+
# Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
48+
# queries: security-extended,security-and-quality
49+
50+
# Autobuild attempts to build any compiled languages (C/C++, C#, Go, or Java).
51+
# If this step fails, then you should remove it and run the build manually (see below)
52+
- name: Autobuild
53+
uses: github/codeql-action/autobuild@v2
54+
55+
# ℹ️ Command-line programs to run using the OS shell.
56+
# 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
57+
58+
# If the Autobuild fails above, remove it and uncomment the following three lines.
59+
# modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
60+
61+
# - run: |
62+
# echo "Run, Build Application using script"
63+
# ./location_of_script_within_repo/buildscript.sh
64+
65+
- name: Perform CodeQL Analysis
66+
uses: github/codeql-action/analyze@v2
67+
with:
68+
category: "/language:python"

‎.github/workflows/cicd.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,11 @@ jobs:
2222
Pre-Commit:
2323
uses: ./.github/workflows/_pre_commit.yml
2424

25+
## Discover vulnerabilities
26+
##
27+
CodeQL:
28+
uses: ./.github/workflows/_codeql.yml
29+
2530
## Builds the package on multiple OS for multiple
2631
## Python versions
2732
##

‎.github/workflows/codeql.yml

Lines changed: 4 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,8 @@
1-
# For most projects, this workflow file will not need changing; you simply need
2-
# to commit it to your repository.
3-
#
4-
# You may wish to alter this file to override the set of languages analyzed,
5-
# or to provide custom queries or build logic.
6-
#
7-
# ******** NOTE ********
8-
# We have attempted to detect the languages in your repository. Please check
9-
# the `language` matrix defined below to confirm you have the correct set of
10-
# supported CodeQL languages.
11-
#
121
name: "CodeQL"
132

143
on:
154
push:
165
branches: ["master"]
17-
pull_request:
18-
# The branches below must be a subset of the branches above
19-
branches: ["master"]
206
schedule:
217
- cron: "19 11 * * 0"
228

@@ -25,53 +11,7 @@ concurrency:
2511
cancel-in-progress: true
2612

2713
jobs:
28-
analyze:
29-
name: Analyze
30-
runs-on: ubuntu-latest
31-
permissions:
32-
actions: read
33-
contents: read
34-
security-events: write
35-
36-
strategy:
37-
fail-fast: false
38-
matrix:
39-
language: ["python"]
40-
# CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
41-
# Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
42-
43-
steps:
44-
- name: Checkout repository
45-
uses: actions/checkout@v3
46-
47-
# Initializes the CodeQL tools for scanning.
48-
- name: Initialize CodeQL
49-
uses: github/codeql-action/init@v2
50-
with:
51-
languages: ${{ matrix.language }}
52-
# If you wish to specify custom queries, you can do so here or in a config file.
53-
# By default, queries listed here will override any specified in a config file.
54-
# Prefix the list here with "+" to use these queries and those in the config file.
55-
56-
# Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
57-
# queries: security-extended,security-and-quality
58-
59-
# Autobuild attempts to build any compiled languages (C/C++, C#, Go, or Java).
60-
# If this step fails, then you should remove it and run the build manually (see below)
61-
- name: Autobuild
62-
uses: github/codeql-action/autobuild@v2
63-
64-
# ℹ️ Command-line programs to run using the OS shell.
65-
# 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
66-
67-
# If the Autobuild fails above, remove it and uncomment the following three lines.
68-
# modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
69-
70-
# - run: |
71-
# echo "Run, Build Application using script"
72-
# ./location_of_script_within_repo/buildscript.sh
73-
74-
- name: Perform CodeQL Analysis
75-
uses: github/codeql-action/analyze@v2
76-
with:
77-
category: "/language:${{ matrix.language }}"
14+
## Discover vulnerabilities
15+
##
16+
CodeQL:
17+
uses: ./.github/workflows/_codeql.yml

‎CHANGELOG.md

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
# Changelog
2+
3+
## [Unreleased](https://github.com/btschwertfeger/python-cmethods/tree/HEAD)
4+
5+
[Full Changelog](https://github.com/btschwertfeger/python-cmethods/compare/v1.0.0...HEAD)
6+
7+
**Fixed bugs:**
8+
9+
- Fixed PyPI repository URL [\#16](https://github.com/btschwertfeger/python-cmethods/pull/16) ([btschwertfeger](https://github.com/btschwertfeger))
10+
11+
## [v1.0.0](https://github.com/btschwertfeger/python-cmethods/tree/v1.0.0) (2023-04-10)
12+
13+
[Full Changelog](https://github.com/btschwertfeger/python-cmethods/compare/v0.6.3...v1.0.0)
14+
15+
**Breaking changes:**
16+
17+
- Remove the unnecessary `CMethods.py` module to access the CMethods class more easily [\#10](https://github.com/btschwertfeger/python-cmethods/issues/10)
18+
19+
**Implemented enhancements:**
20+
21+
- Create a release workflow for dev and production releases [\#8](https://github.com/btschwertfeger/python-cmethods/issues/8)
22+
- Move from setup.py to pyproject.toml [\#7](https://github.com/btschwertfeger/python-cmethods/issues/7)
23+
- Adjusted and improved the examples [\#15](https://github.com/btschwertfeger/python-cmethods/pull/15) ([btschwertfeger](https://github.com/btschwertfeger))
24+
- Improving workflows - adding release workflow [\#12](https://github.com/btschwertfeger/python-cmethods/pull/12) ([btschwertfeger](https://github.com/btschwertfeger))
25+
26+
**Closed issues:**
27+
28+
- Create a documentation [\#9](https://github.com/btschwertfeger/python-cmethods/issues/9)
29+
30+
**Merged pull requests:**
31+
32+
- Moved the content of `CMethods.py` to `__init__.py` and adjusted the imports [\#14](https://github.com/btschwertfeger/python-cmethods/pull/14) ([btschwertfeger](https://github.com/btschwertfeger))
33+
- Create the documentation [\#13](https://github.com/btschwertfeger/python-cmethods/pull/13) ([btschwertfeger](https://github.com/btschwertfeger))
34+
- Move from setup.py to pyproject.toml [\#11](https://github.com/btschwertfeger/python-cmethods/pull/11) ([btschwertfeger](https://github.com/btschwertfeger))
35+
36+
## [v0.6.3](https://github.com/btschwertfeger/python-cmethods/tree/v0.6.3) (2023-03-22)
37+
38+
[Full Changelog](https://github.com/btschwertfeger/python-cmethods/compare/v0.6.2...v0.6.3)
39+
40+
**Breaking changes:**
41+
42+
- adjust_3d forces group to be "time.month" if group is set to the default \(None\) [\#5](https://github.com/btschwertfeger/python-cmethods/issues/5)
43+
44+
**Implemented enhancements:**
45+
46+
- Add pre-commit [\#2](https://github.com/btschwertfeger/python-cmethods/issues/2)
47+
48+
**Fixed bugs:**
49+
50+
- Removed forced 'time.month' grouping in `adjust_3d` when no group was specified [\#4](https://github.com/btschwertfeger/python-cmethods/pull/4) ([btschwertfeger](https://github.com/btschwertfeger))
51+
52+
## [v0.6.2](https://github.com/btschwertfeger/python-cmethods/tree/v0.6.2) (2023-03-14)
53+
54+
[Full Changelog](https://github.com/btschwertfeger/python-cmethods/compare/v0.6.1...v0.6.2)
55+
56+
**Fixed bugs:**
57+
58+
- KeyError when Quantile\* Mapping and group != None [\#3](https://github.com/btschwertfeger/python-cmethods/issues/3)
59+
60+
**Merged pull requests:**
61+
62+
- Added pre-commit workflow to standardize the code base [\#1](https://github.com/btschwertfeger/python-cmethods/pull/1) ([btschwertfeger](https://github.com/btschwertfeger))
63+
64+
## [v0.6.1](https://github.com/btschwertfeger/python-cmethods/tree/v0.6.1) (2022-12-02)
65+
66+
[Full Changelog](https://github.com/btschwertfeger/python-cmethods/compare/v0.6...v0.6.1)
67+
68+
## [v0.6](https://github.com/btschwertfeger/python-cmethods/tree/v0.6) (2022-11-28)
69+
70+
[Full Changelog](https://github.com/btschwertfeger/python-cmethods/compare/v0.5.4.2...v0.6)
71+
72+
## [v0.5.4.2](https://github.com/btschwertfeger/python-cmethods/tree/v0.5.4.2) (2022-11-14)
73+
74+
[Full Changelog](https://github.com/btschwertfeger/python-cmethods/compare/0.5.4.1...v0.5.4.2)
75+
76+
## [0.5.4.1](https://github.com/btschwertfeger/python-cmethods/tree/0.5.4.1) (2022-11-09)
77+
78+
[Full Changelog](https://github.com/btschwertfeger/python-cmethods/compare/v0.5.4...0.5.4.1)
79+
80+
## [v0.5.4](https://github.com/btschwertfeger/python-cmethods/tree/v0.5.4) (2022-11-05)
81+
82+
[Full Changelog](https://github.com/btschwertfeger/python-cmethods/compare/v0.5.3...v0.5.4)
83+
84+
## [v0.5.3](https://github.com/btschwertfeger/python-cmethods/tree/v0.5.3) (2022-10-26)
85+
86+
[Full Changelog](https://github.com/btschwertfeger/python-cmethods/compare/v0.5.2...v0.5.3)
87+
88+
## [v0.5.2](https://github.com/btschwertfeger/python-cmethods/tree/v0.5.2) (2022-10-14)
89+
90+
[Full Changelog](https://github.com/btschwertfeger/python-cmethods/compare/v0.5.1...v0.5.2)
91+
92+
## [v0.5.1](https://github.com/btschwertfeger/python-cmethods/tree/v0.5.1) (2022-08-19)
93+
94+
[Full Changelog](https://github.com/btschwertfeger/python-cmethods/compare/v0.5...v0.5.1)
95+
96+
## [v0.5](https://github.com/btschwertfeger/python-cmethods/tree/v0.5) (2022-08-19)
97+
98+
[Full Changelog](https://github.com/btschwertfeger/python-cmethods/compare/41c1837e5d23c300656c8ee2ce0079d6a8baac2f...v0.5)
99+
100+
\* _This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)_

‎Makefile

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ build:
1717
## Installs the package in edit mode
1818
##
1919
dev:
20-
$(PYTHON) -m pip install -e .[dev]
20+
$(PYTHON) -m pip install -e ".[dev]"
2121

2222
## Install the package
2323
##
@@ -43,6 +43,20 @@ doctest:
4343
pre-commit:
4444
@pre-commit run -a
4545

46+
## Create the changelog
47+
##
48+
## Generate the changelog
49+
##
50+
changelog:
51+
docker run -it --rm \
52+
-v "$(pwd)":/usr/local/src/python-cmethods \
53+
githubchangeloggenerator/github-changelog-generator \
54+
-u btschwertfeger \
55+
-p python-cmethods \
56+
-t $(GHTOKEN) \
57+
--breaking-labels Breaking \
58+
--enhancement-labels Feature
59+
4660
## Clean the workspace
4761
##
4862
clean:

0 commit comments

Comments
 (0)