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 to apie, remove eduhub-specific files #1

Merged
merged 4 commits into from
Dec 1, 2023
Merged

Rename to apie, remove eduhub-specific files #1

merged 4 commits into from
Dec 1, 2023

Conversation

joodie
Copy link
Contributor

@joodie joodie commented Nov 22, 2023

Adjust makefile to allow building standalone apie binary for the local machine.

Adjust makefile to allow building standalone `apie` binary for the
local machine.
Copy link
Contributor

@remvee remvee left a comment

Choose a reason for hiding this comment

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

I think we should get rid of all the "profile" stuff and just focus on a set of rules on a single spec. The "profiles", as defined before this repo existed, not relevant and confusing.

README.md Outdated
@@ -1,79 +1,62 @@
# Eduhub API validator
# Apie 🙈 OpenAPI Service Validator 🙈
Copy link
Contributor

Choose a reason for hiding this comment

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

Too many monkeys.

README.md Outdated
or

```
make apie.exe # on windows (untested)
Copy link
Contributor

Choose a reason for hiding this comment

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

But we're using GH actions to build it, right? So it is tested? Although, I can't find any .exe in the workflow file.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We've tested it on Linux (CI) see the Makefile (when building .zip archive)

current_arch.clj Outdated
os))
systems)))

(println (str system "-" (System/getProperty "os.arch" "unknown")))
Copy link
Contributor

Choose a reason for hiding this comment

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

Move out of root directory into something like dev.

available configuration files in the
[example-profiles](../example-profiles) directory. More examples can
be found in the [eduhub-validator
profiles](https://github.com/SURFnet/eduhub-validator/tree/master/profiles)
Copy link
Contributor

Choose a reason for hiding this comment

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

Why talk about "profiles" at all? Isn't that an eduhub specific thing? It's just a spec, isn't it?

profiles/.keep Outdated
Copy link
Contributor

Choose a reason for hiding this comment

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

Why do we depend on the existance of this file? Can we can rid of "profiles"?

validate Outdated
Copy link
Contributor

Choose a reason for hiding this comment

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

Rename to "apie" or "run". The name "validate" may give the wrong expectation to first time visitor.

- Cleanup root dir
- Document builds a bit more
This is now part of the edhub-validator
@joodie joodie merged commit ef23a67 into master Dec 1, 2023
3 checks passed
@joodie joodie deleted the apie branch December 5, 2023 11:50
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