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

feat: add job manager conventions #68

Closed
wants to merge 3 commits into from

Conversation

razbroc
Copy link

@razbroc razbroc commented Jun 20, 2024

Question Answer
Bug fix
New feature
Breaking change
Deprecations
Documentation
Tests added
Chore

Copy link

Hi it is me, your friendly bot helper! 👋
I've packed this commit for you 😊
You can install it like this:

{
  "dependencies": {
      "@map-colonies/telemetry": "https://ghatmpstorage.blob.core.windows.net/npm-packages/telemetry-8377f018804d710854ce299ee147f2fe47a37b5a.tgz"
  }
}

The link will expire in a week ⌛

@razbroc razbroc requested review from asafMasa and removed request for CptSchnitz and shimoncohen June 23, 2024 08:33
"deprecated": false,
"description": "Array of tasks (uuid array)"
},
"status": {

Choose a reason for hiding this comment

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

do you think jobStatus is better?

Copy link
Author

@razbroc razbroc Jun 23, 2024

Choose a reason for hiding this comment

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

Hmmmm, I believe it might be better to be just "status" since it appears as "status" in DB, and can be used for tasks and jobs.
Should I note it in the description?

Copy link
Collaborator

Choose a reason for hiding this comment

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

even if its like this in the DB, it might be confusing with other statuses across mapcolonies

"status": {
"propertyName": "mapcolonies.infra.job_management.status",
"deprecated": false,
"description": "Status of job as stored on db (COMPLETED/ IN-PROGRESS/ PENDING)"

Choose a reason for hiding this comment

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

(COMPLETED/ IN-PROGRESS/ PENDING, etc.)

Copy link
Author

Choose a reason for hiding this comment

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

added etc. :)

Copy link

Hi it is me, your friendly bot helper! 👋
I've packed this commit for you 😊
You can install it like this:

{
  "dependencies": {
      "@map-colonies/telemetry": "https://ghatmpstorage.blob.core.windows.net/npm-packages/telemetry-d4efd12154e5fd933febfb84a3735bb86ba150e5.tgz"
  }
}

The link will expire in a week ⌛

Copy link

Hi it is me, your friendly bot helper! 👋
I've packed this commit for you 😊
You can install it like this:

{
  "dependencies": {
      "@map-colonies/telemetry": "https://ghatmpstorage.blob.core.windows.net/npm-packages/telemetry-6a73558c6e4adcc4a40abf4dc66de7a2b7f6768d.tgz"
  }
}

The link will expire in a week ⌛

@shimoncohen shimoncohen requested a review from CptSchnitz July 3, 2024 21:32
@shimoncohen shimoncohen added the enhancement New feature or request label Jul 3, 2024
"status": {
"propertyName": "mapcolonies.infra.job_management.status",
"deprecated": false,
"description": "Status of job/task as stored on db (COMPLETED/ IN-PROGRESS/ PENDING, etc.)"
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
"description": "Status of job/task as stored on db (COMPLETED/ IN-PROGRESS/ PENDING, etc.)"
"description": "Status of job/task as stored on db (COMPLETED, IN-PROGRESS, PENDING, etc.)"

@@ -16,7 +16,7 @@
"jobId": {
"propertyName": "mapcolonies.infra.job_management.job_id",
"deprecated": false,
"description": "Type of task as stored on db (uuid)"
"description": "Type of job as stored on db (uuid)"
Copy link
Contributor

Choose a reason for hiding this comment

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

This is not a type but an ID. Please change description accordingly.
This comment is relevant for taskId, jobType, and taskType's desriptions as well.

Copy link
Collaborator

Choose a reason for hiding this comment

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

descriptions*

"taskIds": {
"propertyName": "mapcolonies.infra.job_management.task_ids",
"deprecated": false,
"description": "Array of tasks (uuid array)"
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
"description": "Array of tasks (uuid array)"
"description": "Array of task ids (uuid array)"

@shimoncohen shimoncohen requested a review from asafMasa July 3, 2024 21:40
@razbroc razbroc closed this Jul 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants