Skip to content

feat: use Scribe-Data contract exports instead of hardcoded contracts - #70

Merged
andrewtavis merged 5 commits into
scribe-org:mainfrom
DeleMike:fix/remove-scribe-data-contracts
Jul 18, 2026
Merged

feat: use Scribe-Data contract exports instead of hardcoded contracts#70
andrewtavis merged 5 commits into
scribe-org:mainfrom
DeleMike:fix/remove-scribe-data-contracts

Conversation

@DeleMike

Copy link
Copy Markdown
Collaborator

Contributor checklist

  • This pull request is on a separate branch and not the main branch
  • I have ran the ./pre-commit executable as well as make lint and have fixed all reported issues

Description

Removes the hardcoded contracts/ directory from Scribe-Server. Data contracts are now exported fresh from Scribe-Data on every update run via scribe-data ec, so Scribe-Data remains the single source of truth for contracts and Scribe-Server no longer needs to keep its own copy in sync manually.

  • Added a contracts-export step to update_data.sh, run right before filtering
  • Filtering (scribe-data fd) now always reads from the freshly exported directory
  • Removed the old if [ ! -d "$CONTRACTS_DIR" ] fallback that skipped filtering when contracts were missing — contracts are now guaranteed to be present before filtering runs
  • improved Matrix Success Notification body

Related issue

DeleMike added 2 commits July 17, 2026 21:03
- updated `update_data.sh` to depend on whatever contracts available on the server
- removed unwanted, hardcoded contract files from server
@DeleMike
DeleMike requested review from andrewtavis and axif0 July 17, 2026 20:22
@DeleMike DeleMike self-assigned this Jul 17, 2026
@github-actions

Copy link
Copy Markdown

Thank you for the pull request! 💙

The Scribe-Server team will do our best to address your contribution as soon as we can. The following are some important points:

  • Those interested in developing their skills and expanding their role in the community should read the mentorship and growth section of the contribution guide
  • If you're not already a member of our public Matrix community, please consider joining!
    • We'd suggest that you use the Element client as well as Element X for a mobile app
    • Join the General and Data rooms once you're in
  • Also consider attending our bi-weekly Saturday developer syncs!
    • Details are shared in the General room on Matrix each Wednesday before the sync
    • It would be great to meet you 😊

Note

Scribe uses Conventional Comments in reviews to make sure that communication is as clear as possible.

@github-actions

Copy link
Copy Markdown

Maintainer Checklist

The following is a checklist for maintainers to make sure this process goes as well as possible. Feel free to address the points below yourself in further commits if you realize that actions are needed :)

  • Tests for changes have been written and the continuous integration (CI) workflows within the PR checks do not indicate new errors in the files changed

  • The CHANGELOG has been updated with a description of the changes for the upcoming release and the corresponding issue (if necessary)

@DeleMike

Copy link
Copy Markdown
Collaborator Author

Hey @andrewtavis @axif0

With this PR, Scribe-Server no longer keeps its own hardcoded contracts/ directory; it now runs scribe-data ec as part of update_data.sh, and now keeps Scribe-Data as the single source of truth.

One unrelated thing bundled in: actions/first-interaction@v3 (from #69) renamed its inputs to snake_case and now requires issue_message at runtime, which was breaking the "First PR Contributor Email Check" step on every PR, including this one. I fixed that too.

@scribe-org scribe-org deleted a comment from github-actions Bot Jul 17, 2026
@scribe-org scribe-org deleted a comment from github-actions Bot Jul 17, 2026
@axif0

axif0 commented Jul 17, 2026

Copy link
Copy Markdown
Member

Do we need to load data into MariaDB for serving to the applications? @andrewtavis ? 🤔

@andrewtavis

Copy link
Copy Markdown
Member

As I understand it we do need the data to be in MariaDB in order for it to be sent by the API, @axif0 :)

@DeleMike

Copy link
Copy Markdown
Collaborator Author

I agree @andrewtavis. We need to ensure that the updated data gotten from Scribe-Data is migrated into MariaDB in Toolforge.

@axif0 could you buttress mores on your point, please? I believe I might be missing the point.


BTW, I think we might need to update all our repos if we updated them to follow actions/first-interaction@v3; they have breaking changes as stated in their docs. Look here for reference

@andrewtavis

Copy link
Copy Markdown
Member

Let's maybe change the first issue message to thanking them for the issue and inviting them to join the Matrix, @DeleMike? I could see someone being confused be the email check message if they just open an issue. Also as that issue is mostly for maintainers :)

Feel free to send along a message as described above if it makes sense to you! We can then move to finalize this after the discussion with @axif0 about MariaDB 😊

@andrewtavis

Copy link
Copy Markdown
Member

Feel free to open similar updates for the first contribution action in the other repos, @DeleMike!

@DeleMike

DeleMike commented Jul 18, 2026

Copy link
Copy Markdown
Collaborator Author

I will change the message then we can conclude this PR. Then I will take the accepted message into the other PRs.

Thanks @andrewtavis

Comment thread .github/workflows/pr_maintainer_checklist.yaml
Comment thread .github/workflows/update_scribe_data.yml

@andrewtavis andrewtavis left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

praise: All's looking great here, @DeleMike! So nice to have the issue in Scribe-Server finalize 😊 Now to finish Scribe-Data and bring it all together :) :)

@andrewtavis
andrewtavis merged commit 97e7cc2 into scribe-org:main Jul 18, 2026
@DeleMike

Copy link
Copy Markdown
Collaborator Author

Yes, feels nice too! We can now expand on it as the need arises! One thing I have always thought is improving the Scribe-Server Website, I think I will open a PR for that and we see how that goes. Should do this next week! :)

@DeleMike
DeleMike deleted the fix/remove-scribe-data-contracts branch July 18, 2026 18:59
@andrewtavis

Copy link
Copy Markdown
Member

Interested to see what you're thinking for the website, @DeleMike! :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Remove hard coded contracts from Scribe-Server and use Scribe-Data contracts export

3 participants