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

Rename "prepare" script to "curate" to prevent auto-runs #914

Merged
merged 1 commit into from
Mar 13, 2023

Conversation

tidoust
Copy link
Member

@tidoust tidoust commented Mar 11, 2023

The prepare script is run automatically when the repository is installed. On top of creating issues when the repository is set as dependency in another project for some reason, as described in #789 (comment), this also seems wrong because:

  1. There is no guarantee that the curation will run without errors. A patch may no longer apply for instance. This means that npm install github:w3c/webref may fail from time to time.
  2. Projects may want to depend on the raw data and may not need to run the curation and package preparation logic at all.

This update replaces the "prepare" script with a "curate" one, explicitly called by the jobs that need it.

I don't know if other projects depend on the w3c/webref repository directly. If they do and need to access curated data, they would need to update to call npm run curate explicitly.

The `prepare` script is run when the repository is installed. On top of
creating issues when the repository is set as dependency in another
project for some reason, as described in:
#789 (comment)

... this also seems wrong because:
1. There is no guarantee that the curation will run without errors. A patch
may no longer apply for instance.
2. Projects may want to depend on the raw data and may not need to run the
curation and package preparation logic at all.

This update replaces the "prepare" script with a "curate" one, explicitly
called in the jobs that need it.
@tidoust tidoust merged commit 312adc7 into main Mar 13, 2023
@tidoust tidoust deleted the prepare-curate branch March 13, 2023 06:13
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.

2 participants