-
Notifications
You must be signed in to change notification settings - Fork 0
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: update workflows #175
ci: update workflows #175
Conversation
fd4160e
to
26d36e5
Compare
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.
Why do you update the version in each PR? Is it to see if the CI still works once we merge? Because from a semver POV I don't see the point of creating new identical versions of CL where only the build process (which is invisible to the end-user) has changed.
Is this a question for the status quo or for the future? Currently, the CI requires a version update because we decided so a couple of years ago but I'm exactly removing that in this PR |
Sounds good! 👍 |
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.
Looks great, I just have a suggestion for the generate-docs workflow.
Also, do you know what is going on with the ci/docs
branch? Our documentation is pushed to docs
and the page is hosted from there, but ci/docs
seems to be up to date with main.
.github/workflows/generate-docs.yml
Outdated
push: | ||
branches: | ||
- main | ||
- develop | ||
release: | ||
types: [published] | ||
push: | ||
tags: | ||
- "v*.*.*" |
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 it's still useful to run on main
to have the "development" stream documented. It could help us check if doxygen has formatted everything as we expect, especially if we prepare for a minor or major update.
We could call it rolling
by moving to doxygen/docs/versions/rolling
, and call it latest
+ vX.Y.Z
on tag by making copies. For this you could re-use the "check if version changed" logic in build-release.yml. That would make the list of documented tags on https://aica-technology.github.io/control-libraries/ even nicer to navigate.
The |
Description
This PR solves more items of the parent issue. In particular,
Review guidelines
Estimated Time of Review: 5 minutes
Checklist before merging: