-
Notifications
You must be signed in to change notification settings - Fork 11
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
ci: generate schemas and documentation #8
base: main
Are you sure you want to change the base?
Conversation
It's good practice, one source of truth etc. Signed-off-by: Petr Štetiar <ynezz@true.cz>
Otherwise we might get following issue with older versions: AttributeError: module 'yaml' has no attribute 'FullLoader' Signed-off-by: Petr Štetiar <ynezz@true.cz>
Seems to be not used anywhere. Signed-off-by: Petr Štetiar <ynezz@true.cz>
* generate JSON schemas and documentation * upload documentation artifacts * create index.html for GitHub pages * publish documentation as GitHub pages (only on main branch) Signed-off-by: Petr Štetiar <ynezz@true.cz>
@@ -39,5 +39,37 @@ jobs: | |||
make -j$(($(nproc)+1)) -C $(pwd)/build all | |||
sudo make -C $(pwd)/build install | |||
|
|||
- name: Install Python dependencies for YAML schemas | |||
run: | | |||
sudo apt-get install python3-setuptools |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think setuptools
is already installed:
https://github.com/actions/virtual-environments/blob/main/images/linux/Ubuntu1804-README.md
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's not that hard to check that the documentation is wrong. Who reads the documentation? :-) FYI real error I've tried to fix by that line.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Reported upstream, strange that they messed this up.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Well, it seems like they document and install python-setuptools
for Python2, whereas I'm installing setuptools for Python3.
43ed9dc
to
e9431c8
Compare
74de820
to
1025971
Compare
8c5079d
to
0a9ff8a
Compare
110fc02
to
66694c2
Compare
4fdaeed
to
1bdc8de
Compare
704e471
to
08e0c28
Compare
f926153
to
0a49566
Compare
80727d5
to
7bc2f00
Compare
68b8888
to
35adc26
Compare
3ff0a8d
to
6d83248
Compare
Changes
GitHub pages
Preview https://ynezz.github.io/openwrt-ucentral-schema/
GitHub pages needs to be enabled:
Then the actual docs would get published once the CI workflow on main branch finishes.