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

Add cargo ci alias for ci tool #13280

Merged
merged 2 commits into from May 13, 2024
Merged

Add cargo ci alias for ci tool #13280

merged 2 commits into from May 13, 2024

Conversation

BD103
Copy link
Member

@BD103 BD103 commented May 8, 2024

Objective

Solution

  • Add an opt-in alias to the ci tool with cargo ci ....
    • You need to copy config_fast_builds.toml to config.toml to enable this functionality.

Testing

  • Copy config_fast_builds.toml to config.toml, then run cargo ci --help.

Changelog

  • Added cargo ci alias for internal ci tool.

@BD103 BD103 added D-Trivial Nice and easy! A great choice to get started with Bevy A-Build-System Related to build systems or continuous integration C-Usability A simple quality-of-life change that makes Bevy easier to use X-Uncontroversial This work is generally agreed upon labels May 8, 2024
@BD103
Copy link
Member Author

BD103 commented May 8, 2024

It's unfortunate that this is opt-in, but this is the least-friction solution. The alternative probably would involve:

  • Renaming config_fast_builds.toml to config.toml, breaking a few links on the website.
  • Remove config.toml from .gitignore.
  • Disable all of the fast-build shenanigans by default.

The issue with that is that all changes to config.toml, such as enabling fast builds, would be tracked by Git. I feel like that would interfere with the development workflow too much that it does not justify the change.

@Brezak
Copy link
Contributor

Brezak commented May 8, 2024

Given #13279. Could we add a setup command to our CI tool that asks the contributor some questions and then setups the config.toml for them?

@BD103
Copy link
Member Author

BD103 commented May 8, 2024

That sounds like a great follow-up PR! I'll create an issue for it.

@BD103 BD103 mentioned this pull request May 8, 2024
Copy link
Contributor

@Brezak Brezak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Almost missed this. Small nit:

.cargo/config_fast_builds.toml Show resolved Hide resolved
@BD103 BD103 added the S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it label May 8, 2024
@alice-i-cecile alice-i-cecile added this pull request to the merge queue May 13, 2024
Merged via the queue into bevyengine:main with commit 62bb83c May 13, 2024
28 checks passed
@BD103 BD103 deleted the ci-alias branch May 13, 2024 19:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Build-System Related to build systems or continuous integration C-Usability A simple quality-of-life change that makes Bevy easier to use D-Trivial Nice and easy! A great choice to get started with Bevy S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it X-Uncontroversial This work is generally agreed upon
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create alias to ci tool
4 participants