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

ci: update workflows #175

Merged
merged 8 commits into from
Apr 8, 2024
Merged

ci: update workflows #175

merged 8 commits into from
Apr 8, 2024

Conversation

domire8
Copy link
Member

@domire8 domire8 commented Apr 2, 2024

Description

This PR solves more items of the parent issue. In particular,

  • build-push workflow: deleted since we don't want to build these images anymore
  • build-test: don't update version and changelog automatically but check that changelog is updated on PR and check that all versions correspond to each other
  • build-release: use same workflow as across other organization repos, check if version was updated and create necessary tags for it (rolling if not updated, [rolling,latest,TAG] if updated)
  • doxygen documentation: only on tags, not on push to main

Review guidelines

Estimated Time of Review: 5 minutes

Checklist before merging:

  • Confirm that the relevant changelog(s) are up-to-date in case of any user-facing changes

@domire8 domire8 linked an issue Apr 2, 2024 that may be closed by this pull request
@domire8 domire8 force-pushed the ci/docs branch 3 times, most recently from fd4160e to 26d36e5 Compare April 2, 2024 08:44
LouisBrunner
LouisBrunner previously approved these changes Apr 2, 2024
Copy link

@LouisBrunner LouisBrunner left a 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.

@domire8
Copy link
Member Author

domire8 commented Apr 2, 2024

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

@LouisBrunner
Copy link

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! 👍

Copy link
Member

@eeberhard eeberhard left a 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.

Comment on lines 3 to 5
push:
branches:
- main
- develop
release:
types: [published]
push:
tags:
- "v*.*.*"
Copy link
Member

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.

@domire8
Copy link
Member Author

domire8 commented Apr 8, 2024

The ci/docs branch is the branch name of this PR hehe, sorry for the confusing name.

@domire8 domire8 merged commit 307c964 into develop Apr 8, 2024
5 checks passed
@domire8 domire8 deleted the ci/docs branch April 8, 2024 12:59
@github-actions github-actions bot locked and limited conversation to collaborators Apr 8, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Revamp build structure
3 participants