Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

#291: Project improvements after 0.3.0 release #300

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

benedeki
Copy link
Contributor

@benedeki benedeki commented Nov 7, 2024

  • set credentials persistence to false in GitHub checkout actions
  • fixed release notes presence check GitHub workflow
  • added supported Atum Agent control functions list to documentation
  • added new grouping of issues into release notes draft
  • added badges to README.md

Closes #291

Release Notes:

  • Documentation enhanced including the list of control functions Atum currently supports

* set credentials persistence to `false` in GitHub checkout actions
* fixed release notes presence check GitHub workflow
* added supported Atum Agent control functions list to documentation
* added new grouping of issues into release notes draft
* added badges to `README.md`
@benedeki benedeki added documentation Improvements or additions to documentation infrastructure Project setup and deployment labels Nov 7, 2024
@benedeki benedeki self-assigned this Nov 7, 2024
Copy link

github-actions bot commented Nov 7, 2024

JaCoCo model module code coverage report - scala 2.13.11

Build Failed

Copy link

github-actions bot commented Nov 7, 2024

JaCoCo agent module code coverage report - scala 2.13.11

Build Failed

Copy link

github-actions bot commented Nov 7, 2024

JaCoCo reader module code coverage report - scala 2.13.11

Build Failed

Copy link

github-actions bot commented Nov 7, 2024

JaCoCo server module code coverage report - scala 2.13.11

Build Failed

@@ -1,6 +1,19 @@
# Atum Service

[![Build](https://github.com/AbsaOSS/spark-commons/actions/workflows/build.yml/badge.svg)](https://github.com/AbsaOSS/spark-commons/actions/workflows/build.yml)
[![License](http://img.shields.io/:license-apache-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0.html)
[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://GitHub.com/Naereen/StrapDown.js/graphs/commit-activity)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

beautiful!


The purpose of Atum is to provide means of ensuring no critical fields have been modified during
the processing and no records are added or lost. To do this the library provides an ability
to calculate *hash sums* of explicitly specified columns. We call the set of hash sums at a given time
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we want to explicitly word it like this, hash sums? I think if we are talking about a general measurement perhaps hash sum is a bit too specific / a bit misleading?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

very good text otherwise!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Henestly I didn't write it. I just copied it from Atum and adjusted the function name. It's because last time Manny asked about the supported functions and I found out we don't have them, but old Atum has.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh okay. No worries. But perhaps still, consider changing it

README.md Show resolved Hide resolved
Copy link
Collaborator

@miroslavpojer miroslavpojer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the improvement. I see a lot of TBD. Are they planned to be one in this PR?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation infrastructure Project setup and deployment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Project improvements after 0.3.0 release
3 participants