Skip to content

licence + codefactor badges #29

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

Merged
merged 1 commit into from
Dec 11, 2022
Merged

licence + codefactor badges #29

merged 1 commit into from
Dec 11, 2022

Conversation

kelson42
Copy link

No description provided.

@kelson42 kelson42 requested a review from Jaifroid December 11, 2022 14:07
@kelson42
Copy link
Author

@Jaifroid I wanted to add a badge for the CI on main too... but was not clear to me "what is actually the CI workflow?".

@Jaifroid
Copy link
Collaborator

Jaifroid commented Dec 11, 2022

@kelson42 Currently the CI workflow checks that a PR/push can successfully build the WASM versions. At the moment, it does this from scratch. When I've completed a PR on #12, it will do exactly the same, but by pulling libzim.a and dependencies from the appropriate openzim/release archive. This is a good check for this repo, I think. In an ideal world, we would add some testing, by automating the demo version, that the WASM is good for reading an archive and doing a search. But for now, it's probably a good enough test that the WASM and glue files can all be built successfully against the PR. Does that sound right?

@kelson42
Copy link
Author

@kelson42 Currently the CI workflow checks that a PR/push can successfully build the WASM versions. At the moment, it does this from scratch. When I've completed a PR on #12, it will do exactly the same, but by pulling libzim.a and dependencies from the appropriate openzim/release archive. This is a good check for this repo, I think. In an ideal world, we would add some testing, by automating the demo version, that the WASM is good for reading an archive and doing a search. But for now, it's probably a good enough test that the WASM and glue files can all be built successfully agains the PR. Does that sound right?

Sounds perfect. Current CI is heavy because of the architectural choice. Once you won't compile all the dependencies anymore then we could run it on main at each push.... and put appropriate badge in README.md. That badge is important, at least to me, to quickly now if OK with current code base (and can be released for example).

Copy link
Collaborator

@Jaifroid Jaifroid left a comment

Choose a reason for hiding this comment

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

Apart from the pre-exisitng typo mentioned in comment, looks good to me.

@kelson42 kelson42 merged commit 6bee8db into master Dec 11, 2022
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