ci: refactor msbuild workflow

ReenigneArcher commented 4 months ago

This PR makes some changes the msbuild.yml workflow. I am happy to describe any changes in further detail if needed.

Add additional events for the workflow
- On pull_request allows you to verify if PRs have successful builds and/or download the artifacts for testing. This is limited to opened, synchronized (when new commits are pushed to the PR branch), and re-opened events.
- On push is limited to only the master branch.
- On workflow_dispatch allows you to run this workflow manually if you ever need to check the build state.
The concurrency changes will ensure only a single workflow will run for each ref. This means if a PR contributor pushes new changes to their branch, it will cancel the in process workflow and trigger a new run.
env section was shortened, but equivalent to the previous
Updated versions for three of the github actions used
Removed default values such as:
- shell: pwsh as this is the default for Windows runners
- working-directory: ${{env.GITHUB_WORKSPACE}} as this is the default for all job steps
Used line continuations for long commands
Added a single line break between steps to improve readability

There is a repository setting to configure how github workflows run from outside collaborators. The options are:

require approval for first time contributors
require approval for all outside collaborates (This is what I use for LizardByte, as it reduces runner consumption when I am not ready to merge PRs)

No matter which option you select, PRs from forks will never have access to secrets. There are none in your workflow currently, so this is just FYI.

P.S. In another PR, I would like to add dependabot to help you keep actions and git submodules updated automatically. Unfortunately, it does not have support for vcpkg (see: https://github.com/dependabot/dependabot-core/issues/2027)

Summary by CodeRabbit

New Features
- Enhanced workflow configuration to trigger on pull requests, improving the development process.
Improvements
- Updated action versions for better performance and compatibility.
- Streamlined script executions for improved readability and maintainability.
- Introduced concurrency settings to manage in-progress workflows effectively.
- Added security enhancements for handling certificates in the build process.

coderabbitai[bot] commented 4 months ago

Walkthrough

The .github/workflows/msbuild.yml file has undergone significant enhancements to improve workflow efficiency and responsiveness. Key updates include the addition of triggers for pull requests, refined concurrency settings, and upgraded action versions. The script execution process has been improved for better readability, and environment variables have been integrated. These changes collectively enhance the workflow’s flexibility, maintainability, and reliability within the CI/CD pipeline.

Changes

Files	Change Summary
`.github/.../msbuild.yml`	Added pull request trigger, updated concurrency settings, advanced action versions, refined scripts for readability, integrated environment variables, and upgraded artifact upload actions.

Poem

In workflows where the code does flow,
Updates come with a gentle glow.
Concurrency now wisely tuned,
And scripts by better logic pruned.
Actions updated, artifacts soar,
Efficiency knocks on CI’s door. 🌟

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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 as 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 resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

ReenigneArcher commented 3 months ago

@TheElixZammuto this is working now. https://github.com/ReenigneArcher/moonlight-xbox/actions/runs/10231641854

ReenigneArcher commented 3 months ago

After this is merged, I plan on working on a way to cache the third party builds as that part is quite time consuming (~25 minutes).

ReenigneArcher commented 3 months ago

Looks like i need to tweak something else. I have it working in my repo, so should be close.

https://github.com/ReenigneArcher/moonlight-xbox/pull/1