Clean up this repository

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,30 @@
+---
+name: Bug report
+about: Create a report to help us improve
+labels: 'bug'
+type: 'Bug'
+---
+
+## Describe the bug
+A clear and concise description of what the bug is.
+
+## To Reproduce
+Steps to reproduce the behavior OR commands run:
+1. Go to '...'
+2. Click on '....'
+3. Enter value '...'
+4. See error
+
+## Expected behavior
+A clear and concise description of what you expected to happen.
+
+## Screenshots
+If applicable, add screenshots to help explain your problem.
+
+## Desktop (please complete the following information):
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+## Additional context
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/epic_task.md

@@ -0,0 +1,14 @@
+---
+name: Epic
+about: A larger task consisting of more deliverables
+labels: 'epic'
+type: 'Epic'
+---
+
+## Background
+A clear and concise intro into the situation.
+
+## Goal
+The goal that epic wants to achieve.
+
+[Add actionable subtasks or even epics]

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,21 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+labels: 'enhancement'
+type: 'Feature'
+---
+
+## Background
+A clear and concise description of where the limitation lies.
+
+## Feature
+A description of the requested feature.
+
+## Example [Optional]
+A simple example if applicable.
+
+## Proposed Solution [Optional]
+Solution Ideas:
+1. 
+2. 
+3. 

.github/ISSUE_TEMPLATE/operative_task.md

@@ -0,0 +1,10 @@
+---
+name: Operative task
+about: Issue template for operational tasks.
+labels: 'infrastructure,no RN'
+type: 'Task'
+---
+
+## The task
+
+Short description of the task. 

.github/ISSUE_TEMPLATE/spike_task.md

@@ -0,0 +1,34 @@
+---
+name: Spike
+about: Issue template for spikes, research and investigation tasks
+labels: 'spike'
+type: 'Task'
+---
+
+## Background
+A clear and concise description of the problem or a topic we need to understand.
+
+Feel free to add information about why it's needed and what assumptions you have at the moment.
+
+## Questions To Answer
+
+1.
+2.
+3.
+
+## Desired Outcome
+
+The list of desired outcomes of this spike ticket.
+
+### Tasks
+- [ ] Questions have been answered or we have a clearer idea of how to get to our goal
+- [ ] Discussion with the team
+- [ ] Documentation
+- [ ] Create recommendations and new implementation tickets
+- [ ] item here..
+
+## Additional Info/Resources [Optional]
+
+1. 
+2. 
+3. 

.github/workflows/cd_scala.yml

@@ -1,3 +1,18 @@
+# Copyright 2024 ABSA Group Limited
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
 name: CD Scala
 
 on:
@@ -50,21 +65,3 @@ jobs:
         with:
           name: ${{ env.artifact_name }}
           path: bigfiles/staging
-
-      - name: Aquasec Manifest Generation
-        run: |
-          export BILLY_SERVER=https://billy.eu-1.codesec.aquasec.com
-          curl -sLo install.sh download.codesec.aquasec.com/billy/install.sh
-          curl -sLo install.sh.checksum https://github.com/argonsecurity/releases/releases/latest/download/install.sh.checksum
-          if ! cat install.sh.checksum | sha256sum --check; then
-          echo "install.sh checksum failed"
-          exit 1
-          fi
-          BINDIR="." sh install.sh
-          rm install.sh install.sh.checksum
-          ./billy generate \
-            --access-token "${{ secrets.GITHUB_TOKEN }}" \
-            --aqua-key "${{ secrets.AQUA_KEY }}" \
-            --aqua-secret "${{ secrets.AQUA_SECRET }}" \
-            --cspm-url https://eu-1.api.cloudsploit.com \
-            --artifact-path "${{ github.workspace }}"

.github/workflows/check_pr_release_notes.yml

@@ -1,3 +1,18 @@
+# Copyright 2024 ABSA Group Limited
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
 name: Check PR Release Notes in Description
 
 on:
@@ -16,7 +31,7 @@ jobs:
 
       - name: Check presence of release notes in PR description
         id: check-release-notes
-        uses: AbsaOSS/release-notes-presence-check@v0.2.1
+        uses: AbsaOSS/release-notes-presence-check@v0.3.0
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:

.github/workflows/ci_python.yml

@@ -1,3 +1,18 @@
+# Copyright 2024 ABSA Group Limited
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
 name: CI Python
 
 on:

.github/workflows/ci_scala.yml

@@ -1,3 +1,18 @@
+# Copyright 2024 ABSA Group Limited
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
 name: CI Scala
 
 on:
@@ -60,23 +75,6 @@ jobs:
           script: |
             core.setFailed('Changed files coverage is less than ${{ env.changed }}%!')
 
-      - name: Aquasec Manifest Generation
-        run: |
-          export BILLY_SERVER=https://billy.eu-1.codesec.aquasec.com
-          curl -sLo install.sh download.codesec.aquasec.com/billy/install.sh
-          curl -sLo install.sh.checksum https://github.com/argonsecurity/releases/releases/latest/download/install.sh.checksum
-          if ! cat install.sh.checksum | sha256sum --check; then
-          echo "install.sh checksum failed"
-          exit 1
-          fi
-          BINDIR="." sh install.sh
-          rm install.sh install.sh.checksum
-          ./billy generate \
-            --access-token "${{ secrets.GITHUB_TOKEN }}" \
-            --aqua-key "${{ secrets.AQUA_KEY }}" \
-            --aqua-secret "${{ secrets.AQUA_SECRET }}" \
-            --cspm-url https://eu-1.api.cloudsploit.com \
-            --artifact-path "${{ github.workspace }}"
 
   format-check:
     name: Format Check

.github/workflows/release_draft.yml

@@ -1,3 +1,18 @@
+# Copyright 2024 ABSA Group Limited
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
 name: Release - create draft release
 on:
   workflow_dispatch:

.github/workflows/release_publish.yml

@@ -0,0 +1,70 @@
+# Copyright 2024 ABSA Group Limited
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+name: Release - publish artifacts
+on:
+  release:
+    types: [released]
+
+jobs:
+  publish-jar-file:
+    name: Publish jar file to GitHub Release
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: bigfiles
+    strategy:
+      matrix:
+        include:
+          - scala: 2.12.17
+            scalaShort: "2.12"
+          - scala: 2.11.12
+            scalaShort: "2.11"
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+          fetch-depth: 0
+      - uses: coursier/cache-action@v6
+
+      - name: Setup Scala
+        uses: olafurpg/setup-scala@v14
+        with:
+          java-version: "[email protected]"
+
+      - name: Build jar for Scala ${{ matrix.scala }}
+        run: sbt ++${{ matrix.scala }} assembly
+
+      - name: Create staging directory
+        run: mkdir -p staging
+
+      - name: Copy jar to staging
+        run: |
+          jar_file=$(ls target/scala-${{ matrix.scalaShort }}/dataset-comparison-*.jar)
+          base_name=$(basename $jar_file)
+          cp target/scala-${{ matrix.scalaShort }}/dataset-comparison-*.jar staging/scala-${{ matrix.scalaShort }}$base_name
+          echo "artifact_name=scala-${{ matrix.scalaShort }}-$base_name" >> $GITHUB_ENV
+
+      - name: Info on publish
+        run: |
+          echo "Release: ${{ github.event.release.tag_name }}"
+          echo "Published file: ${{ env.artifact_name  }}"
+          echo "In repo: ${{ github.repository }}"
+
+      - name: Upload JAR file to GitHub Release
+        run: gh release upload ${{ github.event.release.tag_name }} bigfiles/staging --repo ${{ github.repository }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

CONTRIBUTING.md

@@ -0,0 +1,36 @@
+# How to Contribute?
+
+## **Identifying and Reporting Bugs**
+* **Ensure the bug has not already been reported** by searching our **[GitHub Issues](https://github.com/AbsaOSS/generate-release-notes/issues)**.
+* If you cannot find an open issue describing the problem, use the **Bug report** template to open a new one. Tag it with the **bug** label.
+
+## **Proposing New Features**
+
+* **Check if the feature has already been requested** by searching through our **[GitHub Issues](https://github.com/AbsaOSS/generate-release-notes/issues)**.
+* If the feature request doesn't exist, feel free to create a new one. Tag it with the **request** label.
+
+## **Contributing to Development**
+
+* Check _Issues_ logs for the desired feature or bug. Ensure that no one else is already working on it.
+    * If the feature/bug is not yet filed, please create a detailed issue first:
+        * **"Detail Your Idea or Issue"**
+* Fork the repository.
+* Begin coding. Feel free to ask questions and collaborate with us.
+    * Commit messages should reference the GitHub Issue and provide a concise description:
+        * **"#34 Implement Feature X"**
+    * Remember to include tests for your code.
+* Once done, push to your fork and submit a Pull Request to our `master` branch:
+    * Pull Request titles should begin with the GitHub Issue number:
+        * **"45 Implementing New Analytics Feature"**
+    * Ensure the Pull Request description clearly outlines your solution.
+    * Link your PR to the relevant _Issue_.
+
+### Community and Communication
+
+If you have any questions or need help, don't hesitate to reach out through our GitHub discussion section. We're here to help!
+
+#### Thanks!
+
+Your contributions are invaluable to us. Thank you for being part of the AbsaOSS community and helping us grow and improve!
+
+The AbsaOSS Team