chore: preparation for publishing (#5)

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -7,57 +7,32 @@ body:
     attributes:
       value: |
         Before requesting: search [existing issues](../../../../labels/bug).
-
   - type: textarea
     attributes:
       label: Current Behavior
-      description: "Description of the current behavior."
+      description: Description of the current behavior.
     validations:
       required: true
-
   - type: textarea
     attributes:
       label: Expected Behavior
-      description: "Description of the expected behavior."
+      description: Description of the expected behavior.
     validations:
       required: true
-
   - type: textarea
     attributes:
       label: Steps To Reproduce
-      description: "Example steps to reproduce the behavior:"
+      description: 'Example steps to reproduce the behavior:'
       placeholder: |
         1. In this environment...
         2. With this config...
         3. Run '...'
         4. See error...
     validations:
       required: true
-
-  - type: input
-    attributes:
-      label: Environment - OS
-      description: "Linux or Windows"
-    validations:
-      required: true
-
-  - type: input
-    attributes:
-      label: Polarion version
-      description: "2310, 2404, etc..."
-    validations:
-      required: true
-
-  - type: input
-    attributes:
-      label: Extension Version
-      description: "It can be found under https://<<host>>/polarion/#/project/dev/administration/<<Extension Name>>/About"
-    validations:
-      required: true
-
   - type: textarea
     attributes:
       label: Anything else
-      description: "Further hints, links, or references? Any additional information probably helping in root cause analysis."
+      description: Further hints, links, or references? Any additional information probably helping in root cause analysis.
     validations:
       required: false

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -7,26 +7,23 @@ body:
     attributes:
       value: |
         Before requesting: search [existing issues](../../../../labels/enhancement).
-
   - type: textarea
     attributes:
-      label: "Description"
-      description: "Describe the feature you're requesting."
-      placeholder: "This feature adds functionality to ..."
+      label: Description
+      description: Describe the feature you're requesting.
+      placeholder: This feature adds functionality to ...
     validations:
       required: true
-
   - type: textarea
     attributes:
-      label: "Motivation"
-      description: "Describe additional context such as examples or use cases helping in understanding the feature request."
-      placeholder: "This feature would be helpful because ... so that the following use case is addressed: ..."
+      label: Motivation
+      description: Describe additional context such as examples or use cases helping in understanding the feature request.
+      placeholder: 'This feature would be helpful because ... so that the following use case is addressed: ...'
     validations:
       required: true
-
   - type: textarea
     attributes:
-      label: "Proposed Solution (optional)"
-      description: "Sketch an implementation idea, possibly considering multiple approaches."
+      label: Proposed Solution (optional)
+      description: Sketch an implementation idea, possibly considering multiple approaches.
     validations:
       required: false

.github/workflows/pr.yml

@@ -1,31 +1,23 @@
 ---
 name: PR checks
-
 on:
   pull_request:
-    types:
-      - opened
-      - edited
-      - synchronize
-      - reopened
-      - unlocked
-
+    types: [opened, edited, synchronize, reopened, unlocked]
 permissions:
   contents: read
-
 jobs:
   check-conventional-commit:
     name: Check commit messages
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332  # v4
         with:
-          ref: "${{ github.event.pull_request.head.ref }}"
-          repository: "${{ github.event.pull_request.head.repo.full_name }}"
+          ref: ${{ github.event.pull_request.head.ref }}
+          repository: ${{ github.event.pull_request.head.repo.full_name }}
           fetch-depth: 0
-      - uses: actions/setup-python@v5
+      - uses: actions/setup-python@82c7e631bb3cdc910f68e0081d67478d79c6982d  # v5
         with:
-          cache: "pip" # caching pip dependencies
+          cache: pip  # caching pip dependencies
       - run: pip install commitizen
       - name: Check commit messages
         run: cz check --rev-range origin/${GITHUB_BASE_REF}..

.github/workflows/release-please.yml

@@ -12,7 +12,7 @@ jobs:
     steps:
       - name: release-please
         id: release
-        uses: google-github-actions/release-please-action@v4
+        uses: googleapis/release-please-action@7987652d64b4581673a76e33ad5e98e3dd56832f  # v4
         with:
           release-type: maven
-          default-branch: main
+          target-branch: main

.pre-commit-config.yaml

@@ -2,23 +2,22 @@
 default_install_hook_types: [pre-commit, commit-msg]
 repos:
   - repo: https://github.com/lyz-code/yamlfix
-    rev: 1.13.0
+    rev: 1.16.0
     hooks:
       - id: yamlfix
-        args: [-c .yamlfix]
+        args: [-c, .yamlfix.toml]
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.5.0
+    rev: v4.6.0
     hooks:
       - id: check-merge-conflict
       - id: trailing-whitespace
       - id: check-xml
       - id: check-json
       - id: check-yaml
-      - id: detect-private-key
       - id: no-commit-to-branch
       - id: mixed-line-ending
   - repo: https://github.com/zricethezav/gitleaks
-    rev: v8.18.0
+    rev: v8.18.4
     hooks:
       - id: gitleaks
   - repo: https://github.com/grigoriev/pre-commit-check-git-user
@@ -27,6 +26,6 @@ repos:
       - id: check-git-config-user-email
         args: [--templates, ^\S+\.\S+@sbb\.ch$]
   - repo: https://github.com/commitizen-tools/commitizen
-    rev: v3.13.0
+    rev: v3.27.0
     hooks:
       - id: commitizen

.yamlfix → .yamlfix.toml

@@ -1,3 +1,3 @@
 allow_duplicate_keys = false
-line_length = 120
+line_length = 180
 sequence_style = "flow_style"

CONTRIBUTING.md

@@ -26,15 +26,6 @@ All contributors must have an active Polarion license. An active Polarion licens
 ## <a id="asking-questions"></a>Asking questions
 Do not know how something in this project works? Curious if this project can achieve your desired functionality? Please ask questions in this project discussions [here](../../discussions)
 
-## <a id="what-should-i-know-before-i-get-started"></a>What should I know before I get started?
-
-### <a id="tools-and-packages"></a>Tools and Packages
-All extensions provided by SBB Polarion Team can be built, tested and packaged using Maven.
-It is only possible when the dependencies are extract from Polarion installer. The process must be performed by each contributor. Please consider to use **TODO --> ADD LINK TO OUR PYTHON UTILITY** to extract the dependencies for your own Polarion installer version.
-
-### <a id="design-decisions"></a>Design Decisions
-The generic implementation for extensions provided by SBB Polarion Team is located in [ch.sbb.polarion.extension.generic](https://github.com/SchweizerischeBundesbahnen/ch.sbb.polarion.extension.generic)
-
 ## <a id="how-can-i-contribute"></a>How Can I Contribute?
 
 ### <a id="reporting-bugs"></a>Reporting Bugs
@@ -84,7 +75,7 @@ Before you submit your Pull Request (PR) consider the following guidelines:
   Note: The optional commit `-a` command line option will automatically "add" and "rm" edited files.
 
   Note: The command line option `-S` generates a signed commit, which is required to make a contribution (See [Developer Certificate of Origin](./LICENSES/DCO.txt))
-  
+
 * Push your branch to GitHub:
 
     ```shell

LICENSES/SBB.txt

@@ -1,4 +1,5 @@
 Copyright 2024 SBB AG and contributors
+Version 1.0
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

README.md

@@ -20,5 +20,5 @@ polarion-artifacts-deployer.py --polarion-home C:\Polarion --action install
 ```
 To deploy to remote maven repository:
 ```bash
-polarion-artifacts-deployer.py --polarion-home C:\Polarion --action deploy --repository-id polarion.mvn --repository-url https://bin.sbb.ch/artifactory/polarion.mvn
+polarion-artifacts-deployer.py --polarion-home C:\Polarion --action deploy --repository-id <<private-maven-repo-id-from-settings.xml>> --repository-url https://<<private-maven-repo-url>>
 ```

polarion-artifacts-deployer/polarion-artifacts-deployer.py

@@ -9,12 +9,6 @@
 """
 # basic usage:
 python ./polarion-artifacts-deployer.py --polarion-home <polarion_home> --polarion-version <version>
-
-# S3 usage --> ToDo: only possible for Adam right now and the configuration without AWS_PROFILE must be implemented sometime or move to external Maven Repo like repsy.io
-export AWS_DEFAULT_REGION=eu-central-1
-export AWS_PROFILE=lz-polarion-nonprod
-aws-azure-login --all-profiles --no-sandbox --mode=gui
-python ./polarion-artifacts-deployer.py --action deploy --polarion-home ./Polarion/ --polarion-version 2310 --repository-id polarion.mvn --repository-url s3://sbb-polarion-maven-repo/polarion.mvn
 """
 
 

renovate.json

@@ -1,21 +1,6 @@
 {
   "$schema": "https://docs.renovatebot.com/renovate-schema.json",
   "extends": [
-    "config:base",
-    ":prNotPending",
-    ":rebaseStalePrs",
-    ":semanticCommits"
-  ],
-  "branchConcurrentLimit": 1,
-  "packageRules": [
-    {
-      "matchManagers": ["maven"],
-      "allowedVersions": "!/-jboss-|-redhat-|redhat-|-jenkins-|-patch-|-atlassian-|-NODEP$|-atlassian$|-jbossorg-|-SNAPSHOT$|-PFD-|-jbossas-|-does-not-exist|-tc$|-jahia1$/"
-    },
-    {
-      "matchManagers": ["maven"],
-      "matchDepTypes": ["provided", "runtime"],
-      "enabled": false
-    }
+    "github>SchweizerischeBundesbahnen/casc-renovate-preset-polarion-python"
   ]
 }