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

Align file extensions with documentation #9

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

joewiz
Copy link
Member

@joewiz joewiz commented Jul 25, 2023

The user documentation at https://eeditiones.github.io/tuttle-doc/getstarted/configuration/ states:

Tuttle is configured in modules/config.xqm in your Tuttle installation.

This PR changes modules/config.xql to conform with the filename in the documentation.

In the process, it applies the eXist-db (and BaseX) community file extensions to all XQuery modules in the repository - namely, .xq for main modules, and .xqm for library modules.

It adjusts module prologs to use the updated location hints for module imports.

Also, for consistency, it adds newlines to modules that lack them.

The user documentation at https://eeditiones.github.io/tuttle-doc/getstarted/configuration/ states:

> Tuttle is configured in modules/config.xqm in your Tuttle installation.

This changes modules/config.xql to conform with the documentation’s filename.

In the process, it applies the community file extensions to all XQuery modules in the repository - namely, .xq for main modules, and .xqm for library modules.

It adjusts module prologs to use the updated location hints for module imports.

Also, for consistency, it adds newlines to modules that lack them.
@joewiz
Copy link
Member Author

joewiz commented Jul 25, 2023

I meant to note that npm test fails locally - just as in the CI tests here. For tests to pass, it seems to me that GitHub authorization must be stored somewhere - but this sensitive information clearly isn't in the repository. I don't see guidance on this in the README. Can the devs suggest the setup they use for tests to pass?

Copy link
Member

@line-o line-o left a comment

Choose a reason for hiding this comment

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

LGTM

@line-o
Copy link
Member

line-o commented Jul 27, 2023

@joewiz for my local testing I

  • obtained a personal access token from GitHub - it only needs read access to public repositories
  • started the exist-db instance I ran the tests on with export tuttle_token_tuttle_sample_data=<GH-token>; bin/startup.sh

I agree that this should be documented in the readme under "Testing"

@duncdrum
Copy link
Contributor

@joewiz once #22 is merged can you please rebase. We need a more permanent fix to the TOKEN in this repo which only an org owner can do. Maybe we can do that together one of these days, since you have the permissions and I have a plan so to speak.

We can then adjust the docs for local testing.

@duncdrum duncdrum self-requested a review July 27, 2023 22:53
Copy link
Contributor

@duncdrum duncdrum left a comment

Choose a reason for hiding this comment

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

Changes look good. Needs a rebase after #22 has been merged

@joewiz
Copy link
Member Author

joewiz commented Jul 29, 2023

@line-o Thanks for the tip on making the token visible to the test! I can confirm it works.

@duncdrum Sure, I'll be happy to rebase after #22 is merged. And to facilitate your plan for fixing CI.

@line-o
Copy link
Member

line-o commented Oct 4, 2023

@joewiz in the meantime I did a bigger rework of tuttle and now your changes are conflicting I am sorry for causing you extra work. I think we should change the endings as you proposed.

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.

3 participants