diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 196f6b3..a2eac48 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -7,25 +7,22 @@ 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... @@ -33,31 +30,9 @@ body: 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://<>/polarion/#/project/dev/administration/<>/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 diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index a9ac348..216f9c3 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.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 diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml index 4ead895..261ac00 100644 --- a/.github/workflows/pr.yml +++ b/.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}.. diff --git a/.github/workflows/release-please.yml b/.github/workflows/release-please.yml index 438fd48..57493be 100644 --- a/.github/workflows/release-please.yml +++ b/.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 diff --git a/.idea/codeStyles/Project.xml b/.idea/codeStyles/Project.xml deleted file mode 100644 index b8c83cc..0000000 --- a/.idea/codeStyles/Project.xml +++ /dev/null @@ -1,11 +0,0 @@ - - - - \ No newline at end of file diff --git a/.idea/codeStyles/codeStyleConfig.xml b/.idea/codeStyles/codeStyleConfig.xml deleted file mode 100644 index 79ee123..0000000 --- a/.idea/codeStyles/codeStyleConfig.xml +++ /dev/null @@ -1,5 +0,0 @@ - - - - \ No newline at end of file diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index aa74040..a79835b 100644 --- a/.pre-commit-config.yaml +++ b/.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 diff --git a/.yamlfix b/.yamlfix.toml similarity index 76% rename from .yamlfix rename to .yamlfix.toml index 685c363..4d8e209 100644 --- a/.yamlfix +++ b/.yamlfix.toml @@ -1,3 +1,3 @@ allow_duplicate_keys = false -line_length = 120 +line_length = 180 sequence_style = "flow_style" \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b81c2c7..5c2e781 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -26,15 +26,6 @@ All contributors must have an active Polarion license. An active Polarion licens ## 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) -## What should I know before I get started? - -### 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. - -### 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) - ## How Can I Contribute? ### 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 diff --git a/LICENSES/SBB.txt b/LICENSES/SBB.txt index 876a005..f1cdf0a 100644 --- a/LICENSES/SBB.txt +++ b/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. diff --git a/README.md b/README.md index 0731233..5e52431 100644 --- a/README.md +++ b/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 <> --repository-url https://<> ``` diff --git a/RELEASE.md b/RELEASE.md deleted file mode 100644 index 63bc60e..0000000 --- a/RELEASE.md +++ /dev/null @@ -1,19 +0,0 @@ - -# Guidelines for Releases - -## Code Ownership and Automated Release Management - -Releases within our project are exclusively overseen by designated code owners, as outlined in the [/ .github / CODEOWNERS](/.github/CODEOWNERS) file. Our release process is automated using the Release Please GitHub action, which is configured in [/ .github / workflows / release-please.yml](/.github/workflows/release-please.yml). - -## Overview of the Workflow: - -1. For the initial release, the Release Please GitHub action generates a pull request entitled "chore(main): release 1.0.0", marking the commencement of version 1.0.0. This pull request necessitates approval as required. - -2. Following the triumphant launch of the initial version, the action automatically generates another pull request to advance the version to 1.0.1-SNAPSHOT. Prompt approval of this pull request is encouraged post the inaugural release. - -3. Whenever alterations are introduced to the main branch, the Release Please GitHub action dynamically creates or updates the existing pull request, titled "chore(main): release X.Y.Z", where X.Y.Z denotes the version calculated based on Git message history. - -4. Subsequent to each release, the process iterates to update the version to X.Y.Z-SNAPSHOT, thereby preparing a new pull request for the forthcoming X.Y.Z version release. - - -For comprehensive information, please consult the [Release Please documentation](https://github.com/googleapis/release-please). diff --git a/polarion-artifacts-deployer/polarion-artifacts-deployer.py b/polarion-artifacts-deployer/polarion-artifacts-deployer.py index a3a33ca..b4df4e9 100755 --- a/polarion-artifacts-deployer/polarion-artifacts-deployer.py +++ b/polarion-artifacts-deployer/polarion-artifacts-deployer.py @@ -9,12 +9,6 @@ """ # basic usage: python ./polarion-artifacts-deployer.py --polarion-home --polarion-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 """ diff --git a/pom.xml b/pom.xml deleted file mode 100644 index e318fb2..0000000 --- a/pom.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - 4.0.0 - - - ch.sbb.polarion.extensions - ch.sbb.polarion.extension.generic.parent-pom - 2.0.0 - - - ch.sbb.polarion.extension.extension-name - 0.0.0-SNAPSHOT - jar - - - extension-name - ch.sbb.polarion.extension.extension_name - - ${maven-jar-plugin.Extension-Context} - - - - - ch.sbb.polarion.extensions - ch.sbb.polarion.extension.generic.app - ${project.parent.version} - - - - - - - org.apache.maven.plugins - maven-dependency-plugin - - - - org.apache.maven.plugins - maven-jar-plugin - - - - org.apache.maven.plugins - maven-surefire-plugin - - - - org.jacoco - jacoco-maven-plugin - - - - diff --git a/renovate.json b/renovate.json index 332e0cd..ad60032 100644 --- a/renovate.json +++ b/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" ] }