Skip to content

Commit

Permalink
Add more information to release process docs
Browse files Browse the repository at this point in the history
  • Loading branch information
theprash committed Jan 19, 2024
1 parent 1d867c9 commit 353b30e
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 5 deletions.
5 changes: 2 additions & 3 deletions Build.fs
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,6 @@ Target.create "Push" (fun _ ->
let args = $"push %s{nupkgPath} --url https://www.nuget.org"
run "dotnet" $"paket push %s{nupkgPath} --url https://www.nuget.org" "."

let remoteGit = "upstream"
let commitMsg = sprintf "Bumping version to %O" release.NugetVersion
let tagName = string release.NugetVersion

Expand All @@ -90,10 +89,10 @@ Target.create "Push" (fun _ ->

Git.Staging.stageAll ""
Git.Commit.exec "" commitMsg
Git.Branches.pushBranch "" remoteGit "master"
Git.Branches.pushBranch "" "origin" "master"

Git.Branches.tag "" tagName
Git.Branches.pushTag "" remoteGit tagName
Git.Branches.pushTag "" "origin" tagName
)

Target.create "Release" ignore
Expand Down
8 changes: 6 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,10 @@ Pre-requisites:

Steps:

1. Add an entry to `RELEASE_NOTES.md` with the new version, date and release notes
1. Set the `NUGET_KEY` env var
1. Check out the repo at latest `master` commit with the official SAFE-Template repo as the `origin` remote.
1. Ensure you have no other local changes.
1. Add an entry (without committing) to `RELEASE_NOTES.md` with the new version, date and release notes.
1. Set the `NUGET_KEY` env var.
1. Run `dotnet run --project Build.fsproj -- release`

This will release the nuget package and commit and push the release notes to master.

0 comments on commit 353b30e

Please sign in to comment.