Dev

.github/workflows/release.yml

@@ -0,0 +1,137 @@
+name: Create Release
+
+on:
+  push:
+    branches:
+      - main
+      - Dev
+
+permissions:
+  contents: write
+
+jobs:
+  create-release:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # Required for GitVersion to work correctly
+
+      - name: Install GitVersion
+        uses: GitTools/actions/gitversion/setup@v0
+        with:
+          versionSpec: '5.x'
+
+      - name: Determine Version
+        id: gitversion
+        uses: GitTools/actions/gitversion/execute@v0
+
+      - name: Extract Release Notes from Changelog
+        id: extract-changelog
+        uses: release-flow/keep-a-changelog-action@v3.0.0
+        with:
+          command: query
+          version: unreleased
+
+
+      - name: Update CHANGELOG.md
+        if: github.ref == 'refs/heads/main'  # Only update for stable releases
+        uses: release-flow/keep-a-changelog-action@v3.0.0
+        with:
+          command: bump
+          version: unreleased
+
+      - name: Commit Updated CHANGELOG.md
+        if: github.ref == 'refs/heads/main'
+        uses: stefanzweifel/git-auto-commit-action@v5
+        with:
+          commit_message: "Update CHANGELOG for release ${{ steps.gitversion.outputs.semVer }}"
+          file_pattern: "CHANGELOG.md"
+
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+
+      - name: Install Required Python Packages
+        run: pip install build tomlkit
+
+      - name: Update Version in pyproject.toml
+        run: |
+          python - <<EOF
+          import tomlkit
+          pyproject_file = "pyproject.toml"
+          with open(pyproject_file, "r", encoding="utf-8") as f:
+              data = tomlkit.load(f)
+          data["project"]["version"] = "${{ steps.gitversion.outputs.semVer }}"
+          data["tool"]["poetry"]["version"] = "${{ steps.gitversion.outputs.semVer }}"
+          with open(pyproject_file, "w", encoding="utf-8") as f:
+              tomlkit.dump(data, f)
+          EOF
+
+      - name: Commit Updated pyproject.toml
+        uses: stefanzweifel/git-auto-commit-action@v5
+        with:
+          commit_message: "Update pyproject.toml for release ${{ steps.gitversion.outputs.semVer }}"
+          file_pattern: "pyproject.toml"
+
+      - name: Build release distributions
+        run: |
+          # NOTE: put your own distribution build steps here.
+          python -m pip install build
+          python -m build
+
+      - name: Create Git Tag
+        run: |
+          git tag ${{ steps.gitversion.outputs.semVer }}
+          git push origin ${{ steps.gitversion.outputs.semVer }}
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v1
+        with:
+          tag_name: v${{ steps.gitversion.outputs.semVer }}
+          name: Release v${{ steps.gitversion.outputs.semVer }}
+          body: "${{ steps.extract-changelog.outputs.release-notes }}"
+          draft: false
+          prerelease: ${{ github.ref == 'refs/heads/Dev' }}
+          files: |
+            dist/*.whl
+            dist/*.tar.gz
+      - name: Upload distributions
+        uses: actions/upload-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+  pypi-publish:
+    runs-on: ubuntu-latest
+    needs:
+      - create-release
+    if: github.ref == 'refs/heads/main'  # Ensures it only runs for the main branch
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+
+    # Dedicated environments with protections for publishing are strongly recommended.
+    # For more information, see: https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#deployment-protection-rules
+    environment:
+      name: pypi
+      # OPTIONAL: uncomment and update to include your PyPI project URL in the deployment status:
+      # url: https://pypi.org/p/YOURPROJECT
+      #
+      # ALTERNATIVE: if your GitHub Release name is the PyPI project version string
+      # ALTERNATIVE: exactly, uncomment the following line instead:
+      # url: https://pypi.org/project/YOURPROJECT/${{ github.event.release.name }}
+
+    steps:
+      - name: Retrieve release distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+      - name: Publish release distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist/

ChangeLog.md → CHANGELOG.md

@@ -1,8 +1,25 @@
-# Change Log
+# Changelog
 
-## v0.0.2.12
+All notable changes to this project will be documented in this file.
 
-### New Features
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+- Add automatic release notes generation, github release
+- Build fully automated release on push on main
+
+### Changed
+
+- Switch to using "Keep a Changelog" ChangeLog format
+- Change versioning to use semantic versioning (change log had to be updated as well) 
+
+## [v0.0.2-beta.12] - 2025-02-12
+
+### Added
 
 - configuration_items: add class ConfigurationItem
 - configuration_items: add static methods: get_configuration_items, get_by_id
@@ -19,26 +36,26 @@
 - Core: paging, ensure that '<>' gets removed
 
 
-## v0.0.2.11
+## [v0.0.2-beta.11] - 2025-01-08
 
-### New Features
+### Added
 
 - Core: add function decode_api_id and encode_api_id to convert between nodeID and normal ID
 
-## v0.0.2.10
+## [v0.0.2-beta.10] - 2024-12-18
 
-### New Features
+### Added
 
 - Core: add enum LogLevel
 - Core: add method set_log_level to change the log level
 
-### Breaking Changes
+### Changed
 
 - Core: init: parameter for logger has been added, if not provided, a new logger will be created
 
-## v0.0.2.9
+## [v0.0.2-beta.9] - 2024-12-11
 
-### New Features
+### Added
 
 - Request, Workflow, Task, Person, Team: add non static methods: ref_str() --> return a reference string
 - Request: add RequestCategory enum
@@ -51,62 +68,62 @@
 - Tests: add tests for Request
 - Tests: add pre-commit hooks yaml file
 
-### Bugfixes
+### Fixed
 
 - Person, Workflow, Task: inherit JsonSerializableDict --> make serializable
 - Request: close: make it possible to close a without a note (using default note)
 
-### Breaking Changes
+### Changed
 
 - Request: request.created_by, request.requested_by, request.requested_for, request.member are now Person objects
 - Workflow: workflow.manager is now a Person object
 
-## v0.0.2.8
+## [v0.0.2-beta.8] - 2024-12-10
 
-### Bug Fixes
+### Fixed
 
 - Core: __append_per_page: exclude auto append for /me
 
-### Breaking Changes
+### Changed
 
 - Request: request.workflow is now a Workflow object instead of a dict --> request.workflow.id instead of request.workflow['id']
 
-## v0.0.2.7
+## [v0.0.2-beta.7] - 2024-12-10
 
 ### Bug Fixes
 
 - Task: `__update_object__` fixed
 
-## v0.0.2.6
+## [v0.0.2-beta.6] - 2024-12-10
 
 ### Bug Fixes
 
 - Task: Fix update method
 
-## v0.0.2.5
+## [v0.0.2-beta.5] - 2024-12-10
 
 ### Bug Fixes
 
 - Task: Fix update method
 
-## v0.0.2.4
+## [v0.0.2-beta.4] - 2024-12-10
 
-### New Features
+### Added
 
 - People: add non static methods: enable, archive, trash, restore
 - People: add static methods: create, get_people
 - Workflows: add static methods: get_workflows
 
-## v0.0.2.3
+## [v0.0.2-beta.3] - 2024-12-06
 
-### New Features
+### Added
 
 - Task: add non static methods: get_workflow, close, approve, reject, cancel, create
 - Workflow: add non static methods: create_task
 
-## v0.0.2.2
+## [v0.0.2-beta.2] - 2024-12-06
 
-### New Features
+### Added
 
 - Task: add base functionality for tasks
 - Workflow: add methods: get_task_by_template_id, get_tasks
@@ -117,23 +134,23 @@
 
 - Workflow: Fix toString / __str__ method
 
-### Breaking Changes
+### Changed
 
 - Request: renamed get_request to get_requests
 - Workflow: get_workflow_task_by_template_id now returns a Task object List
 
 
-## v0.0.2.1
+## [v0.0.2-beta.1] - 2024-12-06
 
-### New Features
+### Added
 
 - Workflow: add base functionality for workflows
 - People: add base functionality for people
 - core: automatically get api user person object (optional, default: True)
 
-## v0.0.2
+## [v0.0.2-beta.0] - 2024-12-05
 
-### New Features
+### Added
 
 - Request: add methods: archive, trash, restore
 
@@ -142,10 +159,10 @@
 - Request: Fix get_request, get_notes method
 
 
-## v0.0.1
+## [v0.0.1] - 2024-12-05
 
-### New Features
+### Added
 
 - Pagination: auto pagination get requests
 - Retry-after: auto retry after 429 status code
-- custom fields conversion (from and to object/dict)
+- custom fields conversion (from and to object/dict)

GitVersion.yml

@@ -0,0 +1,43 @@
+mode: ContinuousDelivery
+next-version: "0.3.0"
+major-version-bump-message: '\s?(breaking|major|breaking\schange)'
+minor-version-bump-message: '(adds?|features?|minor)\b'
+patch-version-bump-message: '\s?(fix|patch)'
+no-bump-message: '\+semver:\s?(none|skip)'
+assembly-informational-format: '{NuGetVersionV2}+Sha.{Sha}.Date.{CommitDate}'
+branches:
+  master:
+    tag: ""
+    regex: ^main$
+  develop:
+    tag: preview
+    regex: ^Dev$
+    source-branches: ['master']
+  pull-request:
+    tag: PR
+  feature:
+    tag: alpha
+    increment: Minor
+    regex: f(eature(s)?)?[\/-]
+    source-branches: ['master']
+  hotfix:
+    tag: fix
+    increment: Patch
+    regex: (hot)?fix(es)?[\/-]
+    source-branches: ['master']
+
+ignore:
+  sha: []
+merge-message-formats: {}
+
+
+# feature:
+#   tag: useBranchName
+#   increment: Minor
+#   regex: f(eature(s)?)?[/-]
+#   source-branches: ['master']
+# hotfix:
+#   tag: fix
+#   increment: Patch
+#   regex: (hot)?fix(es)?[/-]
+#   source-branches: ['master']