Browse Source

Merge pull request #361 from marcospereirampj/ci/changelog

docs: added changelog creation with cicd
pull/364/head
Richard Nemeth 2 years ago
committed by GitHub
parent
commit
dd6fbbd786
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
  1. 4
      .github/workflows/lint.yaml
  2. 10
      .github/workflows/publish.yaml
  3. 288
      CHANGELOG.md
  4. 2
      docs/source/changelog.rst
  5. 1
      docs/source/index.rst
  6. 8
      tox.ini

4
.github/workflows/lint.yaml

@ -77,7 +77,9 @@ jobs:
build: build:
runs-on: ubuntu-latest runs-on: ubuntu-latest
needs: test
needs:
- test
- check-docs
steps: steps:
- uses: actions/checkout@v3 - uses: actions/checkout@v3
- name: Set up Python 3.10 - name: Set up Python 3.10

10
.github/workflows/publish.yaml

@ -10,6 +10,8 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v3 - uses: actions/checkout@v3
with:
fetch-depth: '0'
- name: Set up Python 3.10 - name: Set up Python 3.10
uses: actions/setup-python@v3 uses: actions/setup-python@v3
with: with:
@ -31,3 +33,11 @@ jobs:
TWINE_PASSWORD: ${{ secrets.TWINE_PASSWORD }} TWINE_PASSWORD: ${{ secrets.TWINE_PASSWORD }}
run: | run: |
twine upload -u $TWINE_USERNAME -p $TWINE_PASSWORD dist/* twine upload -u $TWINE_USERNAME -p $TWINE_PASSWORD dist/*
- name: Run changelog
run: |
tox -e changelog
- uses: stefanzweifel/git-auto-commit-action@v4
with:
commit_message: "docs: changelog update"
branch: master
file_pattern: CHANGELOG.md

288
CHANGELOG.md

@ -1,49 +1,311 @@
# Changelog # Changelog
All notable changes to this project will be documented in this file.
## v2.1.1 (2022-07-19)
## [0.5.0] - 2017-08-21
### Refactor
- applied linting
### Fix
- removed whitespace from urls
## v2.1.0 (2022-07-18)
### Feat
- add functions covering some missing REST API calls
- add unit tests
- add docstrings
- add functions covering some missing REST API calls
### Fix
- linting
- now get_required_action_by_alias now returns None if action does not exist
- moved imports at the top of the file
- remove duplicate function
- applied tox -e docs
- applied flake linting checks
- applied tox linting check
## v2.0.0 (2022-07-17)
### Fix
- check client existence based on clientId
- check client existence based on clientId
### BREAKING CHANGE
- Renamed parameter client_name to client_id in get_client_id method
## v1.9.1 (2022-07-13)
### Fix
- turn get_name into a method, use setters in connection manager
### Refactor
- no need to try if the type check is performed
## v1.9.0 (2022-07-13)
### Refactor
- merge master branch into local
## v1.8.1 (2022-07-13)
### Fix
- Support the auth_url method called with scope & state params now
- Support the auth_url method called with scope & state params now
- raise correct exceptions
### Feat
- added flake8-docstrings and upgraded dependencies
- use poetry for package management
### Refactor
- slight restructure of the base fixtures
## v1.8.0 (2022-06-22)
### Feat
- Ability to set custom timeout for KeycloakOpenId and KeycloakAdmin
- Ability to set custom timeout for KCOpenId and KCAdmin
## v1.7.0 (2022-06-16)
### Feat
- Allow fetching existing policies before calling create_client_authz_client_policy()
## v1.6.0 (2022-06-13)
### Feat
- support token exchange config via admin API
## v1.5.0 (2022-06-03)
### Feat
- Add update_idp
- Add update_idp
## v1.4.0 (2022-06-02)
### Feat
- Add update_mapper_in_idp
- Add update_mapper_in_idp
## v1.3.0 (2022-05-31)
## v1.2.0 (2022-05-31)
### Feat
- Add get_idp_mappers, fix #329
- Support Token Exchange. Fixes #305
## v1.1.1 (2022-05-27)
### Fix
- fixed bugs in events methods
- fixed components bugs
- use param for update client mapper
## v1.1.0 (2022-05-26)
### Feat
- added new methods for client scopes
## v1.0.1 (2022-05-25)
### Fix
- allow query parameters for users count
- allow query parameters for users count
## v1.0.0 (2022-05-25)
### Fix
- correct spelling of public API method
### BREAKING CHANGE
- Renames `KeycloakOpenID.well_know` to `KeycloakOpenID.well_known`
## v0.29.1 (2022-05-24)
### Fix
- allow client_credentials token if username and password not spec…
- allow client_credentials token if username and password not specified
## v0.29.0 (2022-05-23)
### Fix
- added fixes based on feedback
## v0.28.3 (2022-05-23)
### Fix
- import classes in the base module
- import classes in the base module
### Feat
- added UMA-permission request functionality
## v0.28.2 (2022-05-19)
### Fix
- escape when get role fails
## v0.28.1 (2022-05-19)
### Fix
- Add missing keycloak.authorization package
- Add missing keycloak.authorization package
## v0.28.0 (2022-05-19)
## v (2022-05-19)
### Feat
- added authenticator providers getters
- fixed admin client to pass the tests
- initial setup of CICD and linting
### Refactor
- isort conf.py
- Merge branch 'master' into feature/cicd
### Fix
- full tox fix ready
- raise correct errors
## v0.27.1 (2022-05-18)
### Fix
- **release**: version bumps for hotfix release
## v0.27.0 (2022-02-16)
### Fix
- handle refresh_token error "Session not active"
## v0.26.1 (2021-08-30)
### Feat
- add KeycloakAdmin.set_events
- add KeycloakAdmin.set_events
## v0.25.0 (2021-05-05)
## v0.24.0 (2020-12-18)
## 0.23.0 (2020-11-19)
## v0.22.0 (2020-08-16)
## v0.21.0 (2020-06-30)
### Feat
- add components
## v0.20.0 (2020-04-11)
## v0.19.0 (2020-02-18)
## v0.18.0 (2019-12-10)
## v0.17.6 (2019-10-10)
## v0.5.0 (2017-08-21)
### Feat
- Basic functions for Keycloak API (well_know, token, userinfo, logout, certs, - Basic functions for Keycloak API (well_know, token, userinfo, logout, certs,
entitlement, instropect) entitlement, instropect)
## [0.6.0] - 2017-08-23
## v0.6.0 (2017-08-23)
### Feat
- Added load authorization settings - Added load authorization settings
## [0.7.0] - 2017-08-23
## v0.7.0 (2017-08-23)
### Feat
- Added polices - Added polices
## [0.8.0] - 2017-08-23
## v0.8.0 (2017-08-23)
### Feat
- Added permissions - Added permissions
## [0.9.0] - 2017-09-05
## v0.9.0 (2017-09-05)
### Feat
- Added functions for Admin Keycloak API - Added functions for Admin Keycloak API
## [0.10.0] - 2017-10-23
## v0.10.0 (2017-10-23)
### Feat
- Updated libraries versions - Updated libraries versions
- Updated Docs - Updated Docs
## [0.11.0] - 2017-12-12
## v0.11.0 (2017-12-12)
### Feat
- Changed Instropect RPT - Changed Instropect RPT
## [0.12.0] - 2018-01-25
## v0.12.0 (2018-01-25)
### Feat
- Add groups functions - Add groups functions
- Add Admin Tasks for user and client role management - Add Admin Tasks for user and client role management
- Function to trigger user sync from provider - Function to trigger user sync from provider
## [0.12.1] - 2018-08-04
## v0.12.1 (2018-08-04)
### Feat
- Add get_idps - Add get_idps
- Rework group functions - Rework group functions
## [master]
## master
### Feat
* Renamed `KeycloakOpenID.well_know` to `KeycloakOpenID.well_known`
* Add `KeycloakOpenID.token_exchange` to support Token Exchange
- Renamed `KeycloakOpenID.well_know` to `KeycloakOpenID.well_known`
- Add `KeycloakOpenID.token_exchange` to support Token Exchange

2
docs/source/changelog.rst

@ -0,0 +1,2 @@
.. mdinclude:: ../../CHANGELOG.md

1
docs/source/index.rst

@ -11,4 +11,5 @@
:caption: Contents: :caption: Contents:
readme readme
changelog
reference/keycloak/index reference/keycloak/index

8
tox.ini

@ -2,7 +2,7 @@
requires = requires =
tox-poetry tox-poetry
poetry poetry
envlist = check, apply-check, docs, tests, build
envlist = check, apply-check, docs, tests, build, changelog
[testenv] [testenv]
whitelist_externals = whitelist_externals =
@ -40,6 +40,12 @@ commands =
poetry build --format sdist poetry build --format sdist
poetry build --format wheel poetry build --format wheel
[testenv:changelog]
setenv = file|tox.env
passenv = CONTAINER_HOST
commands =
cz changelog --incremental
[flake8] [flake8]
max-line-length = 99 max-line-length = 99
docstring-convention = all docstring-convention = all

Loading…
Cancel
Save