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.

Sign up for GitHub

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

Jump to bottom

Create alias to ci tool #13197

Closed
BD103 opened this issue May 3, 2024 · 0 comments · Fixed by #13280
Closed

Create alias to ci tool #13197

BD103 opened this issue May 3, 2024 · 0 comments · Fixed by #13280
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-Complex Quite challenging from either a design or technical perspective. Ask for help!

Comments

@BD103
Copy link
Member

BD103 commented May 3, 2024

What problem does this solve or what need does it fill?

Writing cargo run -p ci -- ... is lengthy and repetitive.

What solution would you like?

Add an alias, cargo ci, which would be equivalent. This can be added to .cargo/config.toml.

[alias]
ci = "run --package ci --"

Unfortunately there are a few issues with this. config.toml is currently .gitignore-d because we encourage developers to configure their own, faster linkers. By adding the [alias] table for everyone, we would have to remove config.toml from .gitignore, making every local modification to it visible in Git's staged changes.

Even if we had a config.toml with just the [alias] table and config_fast_builds.toml separate, it would still run into the same issue because developers would have to copy the contents of config_fast_builds.toml over, thus showing up in Git.

I'm not sure how to solve this, so I'm creating an issue for it. I think if it were possible to merge multiple config.toml files, this would be perfect, but I can't think of anything right now.

What alternative(s) have you considered?

  • Add this directly to config_fast_builds.toml, so you must opt-in to use the alias.
  • Do not implement this feature.

Additional context
@BD103 BD103 added 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-Complex Quite challenging from either a design or technical perspective. Ask for help! labels May 3, 2024
@BD103 BD103 mentioned this issue May 8, 2024
Merged
github-merge-queue bot pushed a commit that referenced this issue May 13, 2024
@BD103
Add cargo ci alias for ci tool (#13280)
62bb83c 
# Objective

- Running `cargo run --package ci -- ...` is lengthy, and `cargo r -p ci
-- ...` isn't much better.
- Closes #13197.

## 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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
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-Complex Quite challenging from either a design or technical perspective. Ask for help!
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add cargo ci alias for ci tool BD103/bevy
1 participant
@BD103