Skip to content

Commit

Permalink
chore: revert commits that replace the master branch reference by main
Browse files Browse the repository at this point in the history
  • Loading branch information
64J0 committed May 10, 2024
1 parent 191ff21 commit 779ef4f
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 22 deletions.
6 changes: 3 additions & 3 deletions DEVGUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ This documentation must be used as a guide for maintainers and developers for bu

## Release Process

1. Checkout `main` branch
1. `git checkout main`
1. Checkout `master` branch
1. `git checkout master`
2. Add a new entry at the top of the RELEASE_NOTES.md with a version and a date.
1. If possible link to the relevant issues and PRs and credit the author of the PRs
3. Create a new commit
Expand All @@ -14,7 +14,7 @@ This documentation must be used as a guide for maintainers and developers for bu
4. Make a new tag
1. `git tag v6.0.0-beta001`
5. Push changes
1. `git push --atomic origin main v6.0.0-beta001`
1. `git push --atomic origin master v6.0.0-beta001`
6. Create a [new pre-release](https://github.com/giraffe-fsharp/Giraffe/releases) on GitHub
1. Choose the tag you just pushed
2. Title the pre-release the same as the version
Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Read [this blog post on functional ASP.NET Core](https://dusted.codes/functional

- [About](#about)
- [Getting Started](#getting-started)
- [Documentation](https://github.com/giraffe-fsharp/Giraffe/blob/main/DOCUMENTATION.md)
- [Documentation](https://github.com/giraffe-fsharp/Giraffe/blob/master/DOCUMENTATION.md)
- [Sample applications](#sample-applications)
- [Benchmarks](#benchmarks)
- [Building and developing](#building-and-developing)
Expand Down Expand Up @@ -158,7 +158,7 @@ let main _ =
0
```

For more information please check the official [Giraffe documentation](https://github.com/giraffe-fsharp/Giraffe/blob/main/DOCUMENTATION.md).
For more information please check the official [Giraffe documentation](https://github.com/giraffe-fsharp/Giraffe/blob/master/DOCUMENTATION.md).

## Sample applications

Expand Down Expand Up @@ -217,7 +217,7 @@ Help and feedback is always welcome and pull requests get accepted.
### TL;DR

- First open an issue to discuss your changes
- After your change has been formally approved please submit your PR **against the main branch**
- After your change has been formally approved please submit your PR **against the master branch**
- Please follow the code convention by examining existing code
- Add/modify the `README.md` as required
- Add/modify unit tests as required
Expand Down Expand Up @@ -257,9 +257,9 @@ let someHttpHandler : HttpHandler =

If you intend to add or change an existing `HttpHandler` then please update the `README.md` file to reflect these changes there as well. If applicable unit tests must be added or updated and the project must successfully build before a pull request can be accepted.

### Submit a pull request against main
### Submit a pull request against master

The `main` branch is the main and only branch which should be used for all pull requests. A merge into `main` means that your changes are scheduled to go live with the very next release, which could happen any time from the same day up to a couple weeks (depending on priorities and urgency).
The `master` branch is the main and only branch which should be used for all pull requests. A merge into `master` means that your changes are scheduled to go live with the very next release, which could happen any time from the same day up to a couple weeks (depending on priorities and urgency).

Only pull requests which pass all build checks and comply with the general coding guidelines can be approved.

Expand Down Expand Up @@ -308,7 +308,7 @@ If you have blogged about Giraffe, demonstrating a useful topic or some other ti

## License

[Apache 2.0](https://raw.githubusercontent.com/giraffe-fsharp/Giraffe/main/LICENSE)
[Apache 2.0](https://raw.githubusercontent.com/giraffe-fsharp/Giraffe/master/LICENSE)

## Contact and Slack Channel

Expand Down
24 changes: 12 additions & 12 deletions RELEASE_NOTES.md
Original file line number Diff line number Diff line change
Expand Up @@ -323,12 +323,12 @@ For more information please see [issue #347](https://github.com/giraffe-fsharp/G
#### New features
- Support for short GUIDs and short IDs (aka YouTube IDs) [in route arguments](https://github.com/giraffe-fsharp/Giraffe/blob/main/DOCUMENTATION.md#routef) and [query string parameters](https://github.com/giraffe-fsharp/Giraffe/blob/main/DOCUMENTATION.md#short-guids-and-short-ids).
- Support for short GUIDs and short IDs (aka YouTube IDs) [in route arguments](https://github.com/giraffe-fsharp/Giraffe/blob/master/DOCUMENTATION.md#routef) and [query string parameters](https://github.com/giraffe-fsharp/Giraffe/blob/master/DOCUMENTATION.md#short-guids-and-short-ids).
- Enabled [SourceLink](https://github.com/dotnet/sourcelink/) support for Giraffe source code (thanks [Cameron Taggart](https://github.com/ctaggart))! For more information check out [Adding SourceLink to your .NET Core Library](https://carlos.mendible.com/2018/08/25/adding-sourcelink-to-your-net-core-library/).
- Added a new JSON serializer called `Utf8JsonSerializer`. This type uses the [Utf8 JSON serializer library](https://github.com/neuecc/Utf8Json/), which is currently the fastest JSON serializer for .NET. `NewtonsoftJsonSerializer` is still the default JSON serializer in Giraffe (for stability and backwards compatibility), but `Utf8JsonSerializer` can be swapped in via [ASP.NET Core's dependency injection API](https://github.com/giraffe-fsharp/Giraffe/blob/main/DOCUMENTATION.md#json). The new `Utf8JsonnSerializer` is significantly faster (especially when sending chunked responses) than `NewtonsoftJsonSerializer`.
- Added a new `HttpContext` extension method for chunked JSON transfers: `WriteJsonChunkedAsync<'T> (dataObj : 'T)`. This new `HttpContext` method can write content directly to the HTTP response stream without buffering into a byte array first (see [Writing JSON](https://github.com/giraffe-fsharp/Giraffe/blob/main/DOCUMENTATION.md#writing-json)).
- Added a new JSON serializer called `Utf8JsonSerializer`. This type uses the [Utf8 JSON serializer library](https://github.com/neuecc/Utf8Json/), which is currently the fastest JSON serializer for .NET. `NewtonsoftJsonSerializer` is still the default JSON serializer in Giraffe (for stability and backwards compatibility), but `Utf8JsonSerializer` can be swapped in via [ASP.NET Core's dependency injection API](https://github.com/giraffe-fsharp/Giraffe/blob/master/DOCUMENTATION.md#json). The new `Utf8JsonnSerializer` is significantly faster (especially when sending chunked responses) than `NewtonsoftJsonSerializer`.
- Added a new `HttpContext` extension method for chunked JSON transfers: `WriteJsonChunkedAsync<'T> (dataObj : 'T)`. This new `HttpContext` method can write content directly to the HTTP response stream without buffering into a byte array first (see [Writing JSON](https://github.com/giraffe-fsharp/Giraffe/blob/master/DOCUMENTATION.md#writing-json)).
- Added a new `jsonChunked` http handler. This handler is the equivalent http handler version of the `WriteJsonChunkedAsync` extension method.
- Added first class support for [ASP.NET Core's response caching](https://github.com/giraffe-fsharp/Giraffe/blob/main/DOCUMENTATION.md#response-caching) feature.
- Added first class support for [ASP.NET Core's response caching](https://github.com/giraffe-fsharp/Giraffe/blob/master/DOCUMENTATION.md#response-caching) feature.
#### Special thanks
Expand Down Expand Up @@ -369,9 +369,9 @@ Changed the `task {}` CE to load from `FSharp.Control.Tasks.V2.ContextInsensitiv
#### New features
- Added `subRoutef` http handler (see [subRoutef](https://github.com/giraffe-fsharp/Giraffe/blob/main/DOCUMENTATION.md#subroutef))
- Added `routex` and `routeCix` http handler (see [routex](https://github.com/giraffe-fsharp/Giraffe/blob/main/DOCUMENTATION.md#routex))
- Improved model binding (see [Model Binding](https://github.com/giraffe-fsharp/Giraffe/blob/main/DOCUMENTATION.md#model-binding))
- Added `subRoutef` http handler (see [subRoutef](https://github.com/giraffe-fsharp/Giraffe/blob/master/DOCUMENTATION.md#subroutef))
- Added `routex` and `routeCix` http handler (see [routex](https://github.com/giraffe-fsharp/Giraffe/blob/master/DOCUMENTATION.md#routex))
- Improved model binding (see [Model Binding](https://github.com/giraffe-fsharp/Giraffe/blob/master/DOCUMENTATION.md#model-binding))
- Fixed issues: [#121](https://github.com/giraffe-fsharp/Giraffe/issues/121), [#206](https://github.com/giraffe-fsharp/Giraffe/issues/206)
- Added a `TryBindFormAsync` and a `TryBindQueryString` `HttpContext` extension methods
- Added new `HttpHandler` functions to offer a more functional API for model binding:
Expand All @@ -382,7 +382,7 @@ Changed the `task {}` CE to load from `FSharp.Control.Tasks.V2.ContextInsensitiv
- `bindQuery<'T>`
- `tryBindQuery<'T>`
- `bindModel<'T>`
- Added new [Model Validation](https://github.com/giraffe-fsharp/Giraffe/blob/main/DOCUMENTATION.md#model-validation) API
- Added new [Model Validation](https://github.com/giraffe-fsharp/Giraffe/blob/master/DOCUMENTATION.md#model-validation) API
To see an example of the new features you can check the official [Giraffe 1.1.0 release blog post](https://dusted.codes/giraffe-110-more-routing-handlers-better-model-binding-and-brand-new-model-validation-api).
Expand All @@ -399,11 +399,11 @@ This release has many minor breaking changes and a few bigger features. Please r
#### New features
- JSON and XML serialization is now configurable through Dependency Injection (see [Serialization](https://github.com/giraffe-fsharp/Giraffe/blob/main/DOCUMENTATION.md#serialization))
- Added new features to validate conditional HTTP headers before processing a web request (see [Conditional Requests](https://github.com/giraffe-fsharp/Giraffe/blob/main/DOCUMENTATION.md#conditional-requests))
- Added streaming capabilities (see [Streaming](https://github.com/giraffe-fsharp/Giraffe/blob/main/DOCUMENTATION.md#streaming))
- JSON and XML serialization is now configurable through Dependency Injection (see [Serialization](https://github.com/giraffe-fsharp/Giraffe/blob/master/DOCUMENTATION.md#serialization))
- Added new features to validate conditional HTTP headers before processing a web request (see [Conditional Requests](https://github.com/giraffe-fsharp/Giraffe/blob/master/DOCUMENTATION.md#conditional-requests))
- Added streaming capabilities (see [Streaming](https://github.com/giraffe-fsharp/Giraffe/blob/master/DOCUMENTATION.md#streaming))
- Added `HEAD`, `OPTIONS`, `TRACE`, `CONNECT` http handlers
- Added more `HttpContext` extension methods to create parity between response writing methods and `HttpHandler` functions (see [Response Writing](https://github.com/giraffe-fsharp/Giraffe/blob/main/DOCUMENTATION.md#response-writing) and [Content Negotiation](https://github.com/giraffe-fsharp/Giraffe/blob/main/DOCUMENTATION.md#content-negotiation))
- Added more `HttpContext` extension methods to create parity between response writing methods and `HttpHandler` functions (see [Response Writing](https://github.com/giraffe-fsharp/Giraffe/blob/master/DOCUMENTATION.md#response-writing) and [Content Negotiation](https://github.com/giraffe-fsharp/Giraffe/blob/master/DOCUMENTATION.md#content-negotiation))
- Added detailed XML docs to all public facing functions for better Intellisense support
- The `Giraffe.Common` module auto opens now
Expand Down
2 changes: 1 addition & 1 deletion src/Giraffe/Giraffe.fsproj
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<!-- NuGet settings -->
<PackageId>Giraffe</PackageId>
<PackageTags>Giraffe;ASP.NET Core;Lambda;FSharp;Functional;Http;Web;Framework;Micro;Service</PackageTags>
<PackageReleaseNotes>https://raw.githubusercontent.com/giraffe-fsharp/giraffe/main/RELEASE_NOTES.md</PackageReleaseNotes>
<PackageReleaseNotes>https://raw.githubusercontent.com/giraffe-fsharp/giraffe/master/RELEASE_NOTES.md</PackageReleaseNotes>
<PackageProjectUrl>https://github.com/giraffe-fsharp/giraffe</PackageProjectUrl>
<PackageIcon>giraffe-64x64.png</PackageIcon>
<PackageRequireLicenseAcceptance>true</PackageRequireLicenseAcceptance>
Expand Down

0 comments on commit 779ef4f

Please sign in to comment.