Add automatic dev deployment on push

[frcroth]

Currently working on editing this comment, but the Github Token does not alow for that.

https://___.webknossos.xyz

---

(Please delete unneeded items, merge only when none are left open)

• Readd tests in action after new behavior is tested / clear what it should do
• Updated changelog
• Updated migration guide if applicable
• Updated documentation if applicable
• Adapted wk-libs python client if relevant API parts change
• Removed dev-only changes like prints and application.conf edits
• Considered common edge cases
• Needs datastore update after deployment

[fm3]

could we have this maybe only if the PR is ready for review?

[frcroth]

could we have this maybe only if the PR is ready for review?

Done now. As discussed after the presentation, it is not exactly clear how to proceed here. i.e. require a label, what should be the default, is draft status relevant?

[normanrz]

I like the idea of a devdeploy label. Draft state shouldn't matter. Can actions be triggered when a label has been added/removed?

[frcroth]

I like the idea of a devdeploy label. Draft state shouldn't matter. Can actions be triggered when a label has been added/removed?

Yes, it is possible to run a GitHub action on a label change (https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request). However, this would then be a GitHub action and not a circleCI action.
This might also make it possible to change the PR comment more easily to include a link to the dev instance.
This would require the secret for kubernetix also be present in this repo.

Another question would be when this should run:

• Immediately after the label is added and only then
• If the label is placed on the PR after the CircleCI run is done (once)
• above but every time the CI run is done and the label is still active.

[normanrz]

• above but every time the CI run is done and the label is still active.

Maybe it would be best to just check at the end of every CircleCI run whether the label is present and deploy/update accordingly. Removing deployments would still be manual.
Running it in a separate Github action seems to introduce a race condition and I wouldn't want to switch to Github actions entirely just for this auto-deploy.

[normanrz]

Would it make things easier to use the gh CLI tool in CircleCI? It also seems straight-forward to change the PR text: https://cli.github.com/manual/gh_pr_edit. I think we already have a Github token in CircleCI for releases.

[coderabbitai]

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[frcroth]

Waiting for #8147

[frcroth]

With Github CI now used, this should be simpler to do. Closing this PR for now, since this one dealt with circle CI, we can also create a new one.