Blame README.md

2236128
# Overview
d39668a
2236128
This is the .NET Core 3.1 package for Fedora.
2236128
2236128
This package is maintained by the Fedora DotNet SIG (Special Interest
2236128
Group). You can find out more about the DotNet SIG at:
2236128
2236128
- https://fedoraproject.org/wiki/SIGs/DotNet
2236128
- https://fedoraproject.org/wiki/DotNet
2236128
- https://lists.fedoraproject.org/archives/list/dotnet-sig@lists.fedoraproject.org/
2236128
2236128
Please report any issues [using
2236128
bugzilla](https://bugzilla.redhat.com/enter_bug.cgi?product=Fedora&component=dotnet3.1).
2236128
2236128
# Specification
2236128
2236128
This package follows [package naming and contents suggested by
2236128
upstream](https://docs.microsoft.com/en-us/dotnet/core/build/distribution-packaging),
2236128
with one exception. It installs dotnet to `/usr/lib64/dotnet` (aka
2236128
`%{_libdir}`).
2236128
2236128
# Contributing
2236128
2236128
## General Changes
2236128
2236128
1. Fork the repo.
2236128
2236128
2. Checkout the forked repository.
2236128
2236128
    - `git clone ssh://$USER@pkgs.fedoraproject.org/forks/$USER/rpms/dotnet3.1.git`
2236128
    - `cd dotnet3.1`
2236128
2236128
3. Make your changes. Don't forget to add a changelog.
2236128
2236128
4. Do local builds.
2236128
2236128
    - `fedpkg local`
2236128
2236128
5. Fix any errors that come up and rebuild until it works locally.
2236128
2236128
6. Do builds in koji.
2236128
2236128
    - `fedpkg scratch-build --srpm`
2236128
2236128
8. Commit the changes to the git repo.
2236128
2236128
    - `git add` any new patches
2236128
    - `git remove` any now-unnecessary patches
2236128
    - `git commit -a`
2236128
    - `git push`
2236128
2236128
9. Create a pull request with your changes.
2236128
2236128
10. Once the tests in the pull-request pass, and reviewers are happy, do a real
2236128
    build.
2236128
2236128
    - `fedpkg build`
2236128
2236128
11. For non-rawhide releases, file updates using bodhi to ship the just-built
2236128
    package out to users.
2236128
2236128
    - https://bodhi.fedoraproject.org/updates/new
2236128
2236128
    OR
2236128
2236128
    - `fedpkg update`
2236128
2236128
## Updating to an new upstream release
2236128
2236128
1. Fork the repo.
2236128
2236128
2. Checkout the forked repository.
2236128
2236128
    - `git clone ssh://$USER@pkgs.fedoraproject.org/forks/$USER/rpms/dotnet3.1.git`
2236128
    - `cd dotnet3.1`
2236128
2236128
3. Build the new upstream source tarball. Update the versions in the
2236128
   spec file. Add a changelog. This is generally automated by the
2236128
   following.
2236128
2236128
    - `./update-release <sdk-version> <runtime-version>`
2236128
2236128
    If this fails because of compiler errors, you might have to figure
2236128
    out a fix, then add the patch in `build-dotnet-tarball` script
2236128
    rather than the spec file.
2236128
2236128
4. Do local builds.
2236128
2236128
    - `fedpkg local`
2236128
2236128
5. Fix any errors that come up and rebuild until it works locally. Any
2236128
   patches that are needed at this point should be added to the spec file.
2236128
2236128
6. Do builds in koji.
2236128
2236128
    - `fedpkg scratch-build --srpm`
2236128
2236128
7. Upload the source archive to the Fedora look-aside cache.
2236128
2236128
    - `fedpkg new-sources path-to-generated-dotnet-source-tarball.tar.gz`
2236128
2236128
8. Commit the changes to the git repo.
2236128
2236128
    - `git add` any new patches
2236128
    - `git remove` any now-unnecessary patches
2236128
    - `git commit -a`
2236128
    - `git push`
2236128
2236128
9. Create a pull request with your changes.
2236128
2236128
10. Once the tests in the pull-request pass, and reviewers are happy, do a real
2236128
    build.
2236128
2236128
    - `fedpkg build`
2236128
2236128
11. For non-rawhide releases, file updates using bodhi to ship the just-built
2236128
    package out to users.
2236128
2236128
    - https://bodhi.fedoraproject.org/updates/new
2236128
2236128
    OR
2236128
2236128
    - `fedpkg update`
2236128
2236128
# Testing
2236128
2236128
This package uses CI tests as defined in `tests/test.yml`. Creating a
2236128
pull-request or running a build will fire off tests and flag any issues. We have
2236128
enabled gating (via `gating.yaml`) on the tests. That prevents a build
2236128
that fails any test from being released until the failures are waived.
2236128
2236128
The tests themselves are contained in this external repository:
2236128
https://github.com/redhat-developer/dotnet-regular-tests/