Upgrade .NET & add GitHub actions to automatically build Foreman #117
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit upgrades Foreman2 to use .NET 8. This enables us to use proper dependency management and build with the `dotnet` command line tools in preparation for having a proper CI build. Additionally, this enables a newer version of C# and better tooling to detect code issues. I have deleted all files that are irrelevant to the codebase or no longer needed because they are managed by `dotnet`/`nuget` dependency management. Since we're using git, they'll be accessible forever anyway. ForemanTest has also been deleted since it wasn't compilable due to missing functions. Ideally we'll introduce a test suite in future and possibly leverage the now-deleted tests, but since it currently serves no purpose and isn't buildable, remove it.
All warnings issued by the compiler have been eliminated. This mainly revolves around a number of `IDisposable` types that were fields of other `IDisposable`s. The codebase should no longer have any compile-time warnings which sets us up for the option of turning all warnings into errors.
We now use GitHub to build and publish Foreman releases. This consists of two workflows: snapshot and release. The snapshot workflow runs for all commits and archives the artifacts so that you can download them directly from the workflow if you need to debug anything. The release workflow only fires when an annotated tag is pushed and it expects it to be in the format `v1.2.3.4` (replace the numbers as appropriate). The compiled program will automatically be imbued with the version number in the tag. Additionally, the action will prepare a draft release and upload the artifacts into it.
|
I've converted this to a draft since discovering that the serialisation needs a rework to avoid inappropriately trying to serialise fields that shouldn't be serialised. I'll undraft it once it's been fixed up properly. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changeset highlights:
v1.2.3.4) will automatically build a release with the version in the tag (automatically incorporating the version into the binary) and upload the artifacts to a draft Release for you in the Releases section.This should greatly streamline the process of releasing new builds of Foreman2. If you are confident, the draft option can be disabled entirely and the GitHub action can go ahead and make a public release the moment you push an annotated tag to the repo - though you'd possibly want to do more verbose commit messages in that case since that's how we'd have it do release notes for you.