From 69684efac799aa7219afd8075d62f93be3987b45 Mon Sep 17 00:00:00 2001 From: Dave Curylo Date: Mon, 11 Apr 2022 11:15:28 -0400 Subject: [PATCH] Create MAINTAINERS.md --- MAINTAINERS.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 MAINTAINERS.md diff --git a/MAINTAINERS.md b/MAINTAINERS.md new file mode 100644 index 000000000..a5e4737df --- /dev/null +++ b/MAINTAINERS.md @@ -0,0 +1,17 @@ +Maintainers Guide +================= + +This guide is for _maintainers_ who have commit access to the repository and can merge PR's and create release tags. + +Release Process +--------------- + +The release process starts with drafting a new release in GitHub and results in a nuget package published to the public feed. + +1. Update the `` tag in the [Farmer.fsproj](src/Farmer/Farmer.fsproj) file with the version number and commit it to master. +2. Go to [releases](https://github.com/CompositionalIT/farmer/releases) and click "Draft a new Release". +3. Under "Choose a tag", enter the version number for the new package to release to create a tag for the version when it is published. Creating this tag starts the Azure DevOps Pipeline. +4. In "Release Title", name it for the version number as well. This makes it easier to correlate a particular release with the nuget package when viewing the list of releases. +5. In "Describe this release", include the bullet points from the release notes for all the features added in this release. Viewing the "raw" [RELEASE_NOTES.md](https://raw.githubusercontent.com/CompositionalIT/farmer/master/RELEASE_NOTES.md) makes it easier to copy these for the description. +6. Click "Publish Release". +7. Go to the Azure DevOps pipeline and wait for the approval stage. If everything looks good, approve to publish the package to nuget.