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

Add create_outputs and results output #42

Merged
merged 19 commits into from
Sep 28, 2020
Merged

Conversation

CasperWA
Copy link
Member

Closes #41.

The new output will be a JSON object of JSON objects.
The outer objects' keys represent the base URL, it can either be:

  • "unversioned"
  • "vMAJOR"
  • "vMAJOR.MINOR"
  • "vMAJOR.MINOR.PATCH"
    where MAJOR, MINOR, and PATCH represent the current OPTIMADE API version.

New tests to make sure the -j/--json option is used when create_outputs is True.

New CI tests to make sure the output results is correctly created, with the correct content depending on the base URLs checked.

The new output will be a JSON object of JSON objects.
The outer objects' keys represent the base URL, it can either be:
- `"unversioned"`
- `"vMAJOR"`
- `"vMAJOR.MINOR"`
- `"vMAJOR.MINOR.PATCH"`
where MAJOR, MINOR, and PATCH represent the current OPTIMADE API
version.

New tests to make sure the `-j/--json` option is used when
`create_outputs` is `True`.

New CI tests to make sure the output `results` is correctly created,
with the correct content depending on the base URLs checked.
@CasperWA CasperWA changed the title Add create_outputs and results output [BLOCKED] Add create_outputs and results output Sep 22, 2020
@CasperWA
Copy link
Member Author

CasperWA commented Sep 22, 2020

This PR is currently blocked by optimade - a new release is needed with the new -j/--json feature before the new CI can (and should) pass.

Also, at that point the skipped test in tests/test_create_output.bats can be unskipped.

Edit: All done.

@CasperWA CasperWA changed the title [BLOCKED] Add create_outputs and results output Add create_outputs and results output Sep 24, 2020
@CasperWA CasperWA marked this pull request as ready for review September 24, 2020 19:42
@CasperWA CasperWA mentioned this pull request Sep 24, 2020
12 tasks
Copy link
Member

@ml-evs ml-evs left a comment

Choose a reason for hiding this comment

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

Great work @CasperWA, looks really useful. Just some minor comments below:

.github/workflows/validator_action.yml Outdated Show resolved Hide resolved
entrypoint.sh Show resolved Hide resolved
helper.py Outdated Show resolved Hide resolved
helper.py Outdated Show resolved Hide resolved
helper.py Outdated Show resolved Hide resolved
tests/test_fixtures.bash Outdated Show resolved Hide resolved
tests/test_create_output.bats Show resolved Hide resolved
action.yml Show resolved Hide resolved
Copy link
Member

@ml-evs ml-evs left a comment

Choose a reason for hiding this comment

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

This is looking good now, thanks @CasperWA

@CasperWA CasperWA merged commit b409ec6 into master Sep 28, 2020
@CasperWA CasperWA deleted the close_41_json-option branch September 28, 2020 08:49
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.

Add support for -j/--json
2 participants