Skip to content

Commit afb5abf

Browse files
committed
docs: add section for manual releases
1 parent 92733a6 commit afb5abf

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -167,6 +167,8 @@ Conventional Commits are enforced with a pre-commit git hook (using [husky](http
167167

168168
## Releasing
169169

170+
**Note**: Automated releases are not yet fully functional. See [Manual Releases](#manual-releases) for the current process.
171+
170172
All packages are published on nuget.org with a [Github Actions Worfklow](./.github/workflows/release.yml).
171173
The workflow does the following:
172174
- `dotnet versionize` - bump versions and generate changelog
@@ -175,6 +177,24 @@ The workflow does the following:
175177

176178
_Note: only users with write permissions can trigger this workflow (i.e. Collaborators)._
177179

180+
### Manual Releases
181+
182+
Our automated release process is not yet fully functional for the following reason:
183+
Since `Honeybadger` is a dependency of `Honeybadger.Extensions.Logging` and `Honeybadger.DotNetCore`,
184+
we need to release `Honeybadger` first, then update the dependencies in the other projects and finally release those two projects.
185+
186+
To release manually, execute the following steps:
187+
1. Run `dotnet versionize` in the root directory. This will bump the version in all projects and commit the new version as a tag.
188+
2. Run `dotnet pack ./src/Honeybadger --configuration Release`
189+
3. Run `dotnet nuget push ./src/Honeybadger/bin/Release/*.nupkg --source https://api.nuget.org/v3/index.json --api-key YOUR_API_KEY`
190+
4. Update the dependencies in `Honeybadger.Extensions.Logging` and `Honeybadger.DotNetCore` to the new version of `Honeybadger`.
191+
5. Run `dotnet pack ./src/Honeybadger.Extensions.Logging --configuration Release`
192+
6. Run `dotnet nuget push ./src/Honeybadger.Extensions.Logging/bin/Release/*.nupkg --source https://api.nuget.org/v3/index.json --api-key YOUR_API_KEY`
193+
7. Run `dotnet pack ./src/Honeybadger.DotNetCore --configuration Release`
194+
8. Run `dotnet nuget push ./src/Honeybadger.DotNetCore/bin/Release/*.nupkg --source https://api.nuget.org/v3/index.json --api-key YOUR_API_KEY`
195+
9. Commit the changes in the `Honeybadger.Extensions.Logging` and `Honeybadger.DotNetCore` projects.
196+
10. Push the changes to the repository - at this point you will have pushed the git tags + the new versions of the packages to nuget.org.
197+
178198
## TODO
179199

180200
- [ ] Publish README with basic info to setup core nuget

0 commit comments

Comments
 (0)