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

Create workflow to publish releases. #31

Closed
crud89 opened this issue Jun 18, 2021 · 1 comment · Fixed by #32
Closed

Create workflow to publish releases. #31

crud89 opened this issue Jun 18, 2021 · 1 comment · Fixed by #32
Labels
Module: Build 🛠 Issues that involve the build process. Type: Requirement An implementation is required before the next release.

Comments

@crud89
Copy link
Owner

crud89 commented Jun 18, 2021

We should provide a separate script that runs with every commit to the main branch, that builds the documentation and deploys it to a litefx-docs repository. Furthermore, we should forbid commits to the main branch, so that each change needs a branch.

This nicely fits with issue #30.

@crud89 crud89 added Type: Requirement An implementation is required before the next release. Module: Build 🛠 Issues that involve the build process. labels Jun 18, 2021
@crud89
Copy link
Owner Author

crud89 commented Jun 21, 2021

The more optimal solution is to create a workflow to automatically publish a release. The workflow should accept the version parameters on invocation (described here). It then should update the Version.cmake file accordingly and try to create a build for both configurations: Debug and Release. If the build succeeds, it should invoke doxygen to create the documentation. If this also succeeds, it should push the updated Version.cmake file, as well as the generated documentation (see here) to the repository. From the new commit it then should create a new tag and attach the release to it. Another parameter for the workflow would be the changelog.

@crud89 crud89 changed the title Automatically build and deploy documentation after each PR to main. Create workflow to publish releases. Jun 21, 2021
@crud89 crud89 mentioned this issue Jun 21, 2021
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Module: Build 🛠 Issues that involve the build process. Type: Requirement An implementation is required before the next release.
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

1 participant