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

Setup sync with AK #69

Conversation

uittenbroekrobbert
Copy link
Contributor

@uittenbroekrobbert uittenbroekrobbert commented Nov 5, 2024

Description

The Algoritmekader is (now) the source of truth for lifecycles, roles, labels, measures and requirements. This PR adds a sync script which fetches the AK and transforms the data into a format AMT can use.

The Sync script can either sync the data or output a diff report. This script will run daily so we can act on changes in the AK.

Resolves #69

Checklist

Please check all the boxes that apply to this pull request using "x":

  • I have tested the changes locally and verified that they work as expected.
  • I have followed the project's coding conventions and style guidelines.
  • I have rebased my branch onto the latest commit of the main branch.
  • I have squashed or reorganized my commits into logical units.
  • I have read, understood and agree to the Developer Certificate of Origin, which this project utilizes.

@uittenbroekrobbert uittenbroekrobbert force-pushed the 175-setup-mechanism-for-reading-and-migrating-external-datasources-from-ak branch from 60e31de to 9b4a2c1 Compare November 7, 2024 13:13
@uittenbroekrobbert uittenbroekrobbert marked this pull request as ready for review November 7, 2024 13:49
@uittenbroekrobbert uittenbroekrobbert requested a review from a team as a code owner November 7, 2024 13:49
@uittenbroekrobbert uittenbroekrobbert force-pushed the 175-setup-mechanism-for-reading-and-migrating-external-datasources-from-ak branch from 9b4a2c1 to bf4dc47 Compare November 7, 2024 13:52
Copy link
Member

@laurensWe laurensWe left a comment

Choose a reason for hiding this comment

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

Maybe not for this ticket, but how would we go about managing versions? If there is a diff then it could be because the version is different of the specific vereiste but then if the name is different that would now mean a new vereiste with a new URN

Copy link
Member

@anneschuth anneschuth left a comment

Choose a reason for hiding this comment

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

couple of questions

@anneschuth
Copy link
Member

anneschuth commented Nov 7, 2024

Do I understand correctly this will keep alerting us of a diff until we update files in this repo?

Is there a mechanism to update them manually?

(The above was already answered here: #69 (comment))

Once we start versioning the files we're checking/producing, I suppose we should make sure that we're checking against the latest version of these files

@uittenbroekrobbert
Copy link
Contributor Author

uittenbroekrobbert commented Nov 8, 2024

Maybe not for this ticket, but how would we go about managing versions? If there is a diff then it could be because the version is different of the specific vereiste but then if the name is different that would now mean a new vereiste with a new URN

Versioning is out-of-scope for this ticket. Peeking forward, versioning probably will be a delicate puzzle, deciding whether changes are 'patch, minor or major' and what implications that may have in AMT as well.

Copy link
Member

@berrydenhartog berrydenhartog left a comment

Choose a reason for hiding this comment

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

LGTM

@uittenbroekrobbert
Copy link
Contributor Author

Do I understand correctly this will keep alerting us of a diff until we update files in this repo?

Is there a mechanism to update them manually?

(The above was already answered here: #69 (comment))

Once we start versioning the files we're checking/producing, I suppose we should make sure that we're checking against the latest version of these files

AK said they tag their releases, which can be considered the 'latest version' and the sync script retrieves the tags and determine which is latest, so, this should work, in theory.

@uittenbroekrobbert uittenbroekrobbert force-pushed the 175-setup-mechanism-for-reading-and-migrating-external-datasources-from-ak branch from 9bc7e4c to ae4b8d3 Compare November 8, 2024 07:40
# Conflicts:
#	.gitignore
@uittenbroekrobbert uittenbroekrobbert force-pushed the 175-setup-mechanism-for-reading-and-migrating-external-datasources-from-ak branch from ae4b8d3 to bc5d611 Compare November 8, 2024 10:53
Copy link

sonarcloud bot commented Nov 8, 2024

@uittenbroekrobbert uittenbroekrobbert merged commit c08ff9a into main Nov 8, 2024
13 of 15 checks passed
@uittenbroekrobbert uittenbroekrobbert deleted the 175-setup-mechanism-for-reading-and-migrating-external-datasources-from-ak branch November 8, 2024 11:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
5 participants