Skip to content

Commit 7b399a0

Browse files
chore: update GitHub branch references to use HEAD (#1032)
1 parent 4796a9c commit 7b399a0

File tree

10 files changed

+44
-44
lines changed

10 files changed

+44
-44
lines changed

CHANGELOG.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -241,13 +241,13 @@ All notable changes to this project will be documented in this file.
241241
## Added
242242
- #509 Transient Fault Handling (dependency free)
243243
- Implements retry behaviour for transient faults when using HttpClient to send the request.
244-
- Please see #509 and [USE_CASES.md](https://github.com/sendgrid/sendgrid-csharp/blob/master/USE_CASES.md#transient_faults) for details.
244+
- Please see #509 and [USE_CASES.md](USE_CASES.md#transient_faults) for details.
245245
- Thanks to [Dylan Morley](https://github.com/dylan-asos) for the PR!
246246

247247
## [9.8.0] - 2017-08-15
248248
## Added
249249
- Single email to multiple recipients - Toggle display of recipients #508
250-
- The method `CreateSingleEmailToMultipleRecipients` now has an additional optional parameter to control whether the email recipients can see each others email addresses. Please see [USE_CASES.md](https://github.com/sendgrid/sendgrid-csharp/blob/master/USE_CASES.md#singleemailmultiplerecipients) for details.
250+
- The method `CreateSingleEmailToMultipleRecipients` now has an additional optional parameter to control whether the email recipients can see each others email addresses. Please see [USE_CASES.md](USE_CASES.md#singleemailmultiplerecipients) for details.
251251
- Thanks to [Niladri Dutta](Niladri24dutta) for the PR!
252252

253253
## [9.7.0] - 2017-08-03
@@ -350,7 +350,7 @@ All notable changes to this project will be documented in this file.
350350
## [8.0.4] - 2016-08-24 ##
351351
### Added
352352
- Table of Contents in the README
353-
- Added a [USE_CASES.md](https://github.com/sendgrid/sendgrid-csharp/blob/master/USE_CASES.md) section, with the first use case example for transactional templates
353+
- Added a [USE_CASES.md](USE_CASES.md) section, with the first use case example for transactional templates
354354

355355
## [8.0.3] - 2016-08-17 ##
356356
## Fixed
@@ -365,7 +365,7 @@ All notable changes to this project will be documented in this file.
365365

366366
## [8.0.1] - 2016-07-25 ##
367367
### Added
368-
- [Troubleshooting](https://github.com/sendgrid/sendgrid-csharp/blob/master/TROUBLESHOOTING.md) section
368+
- [Troubleshooting](TROUBLESHOOTING.md) section
369369

370370
## [8.0.0] - 2016-07-22 ##
371371
## BREAKING CHANGE

CONTRIBUTING.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -77,27 +77,27 @@ Next, update your Environment with your [SENDGRID_APIKEY](https://app.sendgrid.c
7777
##### Execute: #####
7878

7979
- Check out the documentation for [Web API v3 endpoints](https://sendgrid.com/docs/API_Reference/Web_API_v3/index.html).
80-
- Review the corresponding [examples](https://github.com/sendgrid/sendgrid-csharp/blob/master/examples).
81-
- You can add your test code to our [Example Project](https://github.com/sendgrid/sendgrid-csharp/blob/master/ExampleCoreProject/Example.cs).
80+
- Review the corresponding [examples](examples).
81+
- You can add your test code to our [Example Project](ExampleCoreProject/Program.cs).
8282

8383
<a name="understanding-the-codebase"></a>
8484
## Understanding the Code Base
8585

86-
- **[/examples](https://github.com/sendgrid/sendgrid-csharp/blob/master/examples)**
86+
- **[/examples](examples)**
8787
- Examples that demonstrate usage.
88-
- **[/ExampleCoreProject/Example.cs](https://github.com/sendgrid/sendgrid-csharp/blob/master/ExampleCoreProject/Example.cs)**
88+
- **[/ExampleCoreProject/Program.cs](ExampleCoreProject/Program.cs)**
8989
- A working .NET Core example project for testing.
90-
- **[/ExampleNet45Project/Example.cs](https://github.com/sendgrid/sendgrid-csharp/blob/master/ExampleNet45Project/Example.cs)**
90+
- **[/ExampleNet45Project/Program.cs](ExampleNet45Project/Program.cs)**
9191
- A working .NET 4.5.2 example project for testing.
92-
- **[/src/SendGrid/SendGridClient.cs](https://github.com/sendgrid/sendgrid-csharp/blob/master/src/SendGrid/SendGridClient.cs)**
92+
- **[/src/SendGrid/SendGridClient.cs](src/SendGrid/SendGridClient.cs)**
9393
- The main interface to the Twilio SendGrid API is the class `SendGridClient`.
94-
- **[/tests/SendGrid.Tests/Integration.cs](https://github.com/sendgrid/sendgrid-csharp/blob/master/tests/SendGrid.Tests/Integration.cs)**
94+
- **[/tests/SendGrid.Tests/Integration.cs](tests/SendGrid.Tests/Integration.cs)**
9595
- Integration tests
9696

9797
<a name="testing"></a>
9898
## Testing
9999

100-
All PRs require passing tests before the PR will be reviewed. All test files are in the [`SendGrid.Tests`](https://github.com/sendgrid/sendgrid-csharp/blob/master/tests/SendGrid.Tests) directory. For the purposes of contributing to this repo, please update the [`Integration.cs`](https://github.com/sendgrid/sendgrid-csharp/blob/master/tests/SendGrid.Tests/Integration.cs) file with unit tests as you modify the code.
100+
All PRs require passing tests before the PR will be reviewed. All test files are in the [`SendGrid.Tests`](tests/SendGrid.Tests) directory. For the purposes of contributing to this repo, please update the [`Integration.cs`](tests/SendGrid.Tests/Integration.cs) file with unit tests as you modify the code.
101101

102102
The integration tests require a Twilio SendGrid mock API in order to execute. We've simplified setting this up using Docker to run the tests. You will just need [Docker Desktop](https://docs.docker.com/get-docker/) and `make`.
103103

@@ -106,7 +106,7 @@ Once these are available, simply execute the Docker test target to run all tests
106106
<a name="style-guidelines-and-naming-conventions"></a>
107107
## Style Guidelines & Naming Conventions
108108

109-
Generally, we follow the style guidelines as suggested by the official language. However, we ask that you conform to the styles that already exist in the library. If you wish to deviate, please explain your reasoning. In this case, we generally follow the [C# Naming Conventions](https://msdn.microsoft.com/library/ms229045(v=vs.100).aspx), the suggestions provided by the Visual Studio IDE and StyleCop (see the [stylecop.json](https://github.com/sendgrid/sendgrid-csharp/blob/master/src/SendGrid/stylecop.json) and [SendGrid.ruleset](https://github.com/sendgrid/sendgrid-csharp/blob/master/src/SendGrid/SendGrid.ruleset) configuration files.
109+
Generally, we follow the style guidelines as suggested by the official language. However, we ask that you conform to the styles that already exist in the library. If you wish to deviate, please explain your reasoning. In this case, we generally follow the [C# Naming Conventions](https://msdn.microsoft.com/library/ms229045(v=vs.100).aspx), the suggestions provided by the Visual Studio IDE and StyleCop (see the [stylecop.json](src/SendGrid/stylecop.json) and [SendGrid.ruleset](src/SendGrid/SendGrid.ruleset) configuration files.
110110

111111
<a name="creating-a-pull-request"></a>
112112
## Creating a Pull Request

README.md

+19-19
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
![SendGrid Logo](https://github.com/sendgrid/sendgrid-python/raw/master/twilio_sendgrid_logo.png)
1+
![SendGrid Logo](twilio_sendgrid_logo.png)
22

3-
[![BuildStatus](https://travis-ci.org/sendgrid/sendgrid-csharp.png?branch=master)](https://travis-ci.org/sendgrid/sendgrid-csharp)
3+
[![BuildStatus](https://travis-ci.org/sendgrid/sendgrid-csharp.png?branch=main)](https://travis-ci.org/sendgrid/sendgrid-csharp)
44
[![NuGet](https://img.shields.io/nuget/v/SendGrid.svg)](https://www.nuget.org/packages/SendGrid)
55
[![Email Notifications Badge](https://dx.sendgrid.com/badge/csharp)](https://dx.sendgrid.com/newsletter/csharp)
66
[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE.md)
@@ -12,17 +12,17 @@
1212
**The default branch name for this repository has been changed to `main` as of 07/27/2020.**
1313

1414
* Subscribe to email [notifications](https://dx.sendgrid.com/newsletter/csharp) for releases and breaking changes.
15-
* Send SMS messages with [Twilio](https://github.com/sendgrid/sendgrid-csharp/blob/master/USE_CASES.md#sms).
15+
* Send SMS messages with [Twilio](USE_CASES.md#sms).
1616

1717
# Overview
1818

1919
**This library allows you to quickly and easily use the Twilio SendGrid Web API v3 via C# with .NET.**
2020

2121
Version 9.X.X+ of this library provides full support for all Twilio SendGrid [Web API v3](https://sendgrid.com/docs/API_Reference/api_v3.html) endpoints, including the new [v3 /mail/send](https://sendgrid.com/blog/introducing-v3mailsend-sendgrids-new-mail-endpoint).
2222

23-
We want this library to be community driven, and Twilio SendGrid led. We need your help to realize this goal. To help make sure we are building the right things in the right order, we ask that you create [issues](https://github.com/sendgrid/sendgrid-csharp/issues) and [pull requests](https://github.com/sendgrid/sendgrid-csharp/blob/master/CONTRIBUTING.md) or simply upvote or comment on existing issues or pull requests.
23+
We want this library to be community driven, and Twilio SendGrid led. We need your help to realize this goal. To help make sure we are building the right things in the right order, we ask that you create [issues](https://github.com/sendgrid/sendgrid-csharp/issues) and [pull requests](CONTRIBUTING.md) or simply upvote or comment on existing issues or pull requests.
2424

25-
For updates to this library, see our [CHANGELOG](https://github.com/sendgrid/sendgrid-csharp/blob/master/CHANGELOG.md) and [releases](https://github.com/sendgrid/sendgrid-csharp/releases).
25+
For updates to this library, see our [CHANGELOG](CHANGELOG.md) and [releases](https://github.com/sendgrid/sendgrid-csharp/releases).
2626

2727
Subscribe to email [release notifications](https://dx.sendgrid.com/newsletter/csharp) to receive emails about releases and breaking changes.
2828

@@ -104,11 +104,11 @@ dotnet add package SendGrid.Extensions.DependencyInjection
104104
```
105105

106106
Once you have the Twilio SendGrid library installed, you can include calls to it in your code.
107-
For sample implementations, see the [.NET Core Example](https://github.com/sendgrid/sendgrid-csharp/tree/master/ExampleCoreProject) and the [.NET 4.5.2 Example](https://github.com/sendgrid/sendgrid-csharp/tree/master/ExampleNet45Project) folders.
107+
For sample implementations, see the [.NET Core Example](ExampleCoreProject) and the [.NET 4.5.2 Example](ExampleNet45Project) folders.
108108

109109
## Dependencies
110110

111-
Please see the [.csproj file](https://github.com/sendgrid/sendgrid-csharp/blob/master/src/SendGrid/SendGrid.csproj).
111+
Please see the [.csproj file](src/SendGrid/SendGrid.csproj).
112112

113113
# Quick Start
114114

@@ -169,7 +169,7 @@ class Program
169169
}
170170
```
171171

172-
You can find an example of all the email features [here](https://github.com/sendgrid/sendgrid-csharp/blob/master/tests/SendGrid.Tests/Integration.cs#L79).
172+
You can find an example of all the email features [here](tests/SendGrid.Tests/Integration.cs#L79).
173173

174174
<a name="v3"></a>
175175
## General v3 Web API Usage
@@ -244,34 +244,34 @@ class Program
244244
# Usage
245245

246246
- [Twilio SendGrid Docs](https://sendgrid.com/docs/API_Reference/api_v3.html)
247-
- [Library Usage Docs](https://github.com/sendgrid/sendgrid-csharp/tree/master/USAGE.md)
248-
- [Example Code - .NET Core](https://github.com/sendgrid/sendgrid-csharp/tree/master/ExampleCoreProject)
249-
- [Example Code - .NET 4.5.2+](https://github.com/sendgrid/sendgrid-csharp/tree/master/ExampleNet45Project)
247+
- [Library Usage Docs](USAGE.md)
248+
- [Example Code - .NET Core](ExampleCoreProject)
249+
- [Example Code - .NET 4.5.2+](ExampleNet45Project)
250250
- [How-to: Migration from v2 to v3](https://sendgrid.com/docs/Classroom/Send/v3_Mail_Send/how_to_migrate_from_v2_to_v3_mail_send.html)
251-
- [v3 Web API Mail Send Helper](https://github.com/sendgrid/sendgrid-csharp/tree/master/src/SendGrid/Helpers/Mail)
251+
- [v3 Web API Mail Send Helper](src/SendGrid/Helpers/Mail)
252252

253253
# Use Cases
254254

255-
Here are some [examples of common API use cases](https://github.com/sendgrid/sendgrid-csharp/blob/master/USE_CASES.md), such as how to send an email with a transactional template.
255+
Here are some [examples of common API use cases](USE_CASES.md), such as how to send an email with a transactional template.
256256

257257
# Roadmap
258258

259259
If you are interested in the future direction of this project, please take a look at our open [issues](https://github.com/sendgrid/sendgrid-csharp/issues) and [pull requests](https://github.com/sendgrid/sendgrid-csharp/pulls). We would love to hear your feedback!
260260

261261
# How to Contribute
262262

263-
We encourage contribution to our library (you might even score some nifty swag), please see our [CONTRIBUTING](https://github.com/sendgrid/sendgrid-csharp/tree/master/CONTRIBUTING.md) guide for details.
263+
We encourage contribution to our library (you might even score some nifty swag), please see our [CONTRIBUTING](CONTRIBUTING.md) guide for details.
264264

265265
Quick links:
266266

267-
- [Feature Request](https://github.com/sendgrid/sendgrid-csharp/tree/master/CONTRIBUTING.md#feature-request)
268-
- [Bug Reports](https://github.com/sendgrid/sendgrid-csharp/tree/master/CONTRIBUTING.md#submit-a-bug-report)
269-
- [Improvements to the Codebase](https://github.com/sendgrid/sendgrid-csharp/tree/master/CONTRIBUTING.md#improvements-to-the-codebase)
270-
- [Review Pull Requests](https://github.com/sendgrid/sendgrid-csharp/tree/master/CONTRIBUTING.md#code-reviews)
267+
- [Feature Request](CONTRIBUTING.md#feature-request)
268+
- [Bug Reports](CONTRIBUTING.md#submit-a-bug-report)
269+
- [Improvements to the Codebase](CONTRIBUTING.md#improvements-to-the-codebase)
270+
- [Review Pull Requests](CONTRIBUTING.md#code-reviews)
271271

272272
# Troubleshooting
273273

274-
Please see our [troubleshooting guide](https://github.com/sendgrid/sendgrid-csharp/blob/master/TROUBLESHOOTING.md) for common library issues.
274+
Please see our [troubleshooting guide](TROUBLESHOOTING.md) for common library issues.
275275

276276
# About
277277

TROUBLESHOOTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ In most cases we recommend you download the latest version of the library, but i
171171
<a name="versioning"></a>
172172
## Versioning Convention
173173

174-
We follow the MAJOR.MINOR.PATCH versioning scheme as described by [SemVer.org](http://semver.org). Therefore, we recommend that you always pin (or vendor) the particular version you are working with to your code and never auto-update to the latest version. Especially when there is a MAJOR point release, since that is guaranteed to be a breaking change. Changes are documented in the [CHANGELOG](https://github.com/sendgrid/sendgrid-csharp/blob/master/CHANGELOG.md) and [releases](https://github.com/sendgrid/sendgrid-csharp/releases) section.
174+
We follow the MAJOR.MINOR.PATCH versioning scheme as described by [SemVer.org](http://semver.org). Therefore, we recommend that you always pin (or vendor) the particular version you are working with to your code and never auto-update to the latest version. Especially when there is a MAJOR point release, since that is guaranteed to be a breaking change. Changes are documented in the [CHANGELOG](CHANGELOG.md) and [releases](https://github.com/sendgrid/sendgrid-csharp/releases) section.
175175

176176
<a name="request-body"></a>
177177
## Viewing the Request Body

USAGE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2450,7 +2450,7 @@ For more detailed information about how to use the v3 Mail Send endpoint, please
24502450

24512451
### POST /mail/send
24522452

2453-
This endpoint has a helper, check it out [here](https://github.com/sendgrid/sendgrid-csharp/blob/master/src/SendGrid/Helpers/Mail).
2453+
This endpoint has a helper, check it out [here](src/SendGrid/Helpers/Mail).
24542454

24552455
```csharp
24562456
string data = @"{

USE_CASES.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ namespace Example
141141
};
142142
msg.AddHeaders(headers);
143143

144-
// If you require complex substitutions this [use case](https://github.com/sendgrid/sendgrid-csharp/blob/master/USE_CASES.md#transactional-templates).
144+
// If you require complex substitutions this [use case](USE_CASES.md#transactional-templates).
145145
var dynamicTemplateData = new ExampleTemplateData
146146
{
147147
Subject = "Hi!",
@@ -201,7 +201,7 @@ namespace Example
201201
};
202202
msg.AddHeaders(headers1, 1);
203203

204-
// For a full transactional template example, please see this [use case](https://github.com/sendgrid/sendgrid-csharp/blob/master/USE_CASES.md#transactional-templates).
204+
// For a full transactional template example, please see this [use case](USE_CASES.md#transactional-templates).
205205
var dynamicTemplateData2 = new ExampleTemplateData
206206
{
207207
Subject = "Hi 2!",
@@ -244,7 +244,7 @@ namespace Example
244244
msg.AddContents(contents);
245245

246246
// For base64 encoding, see [`Convert.ToBase64String`](https://msdn.microsoft.com/en-us/library/system.convert.tobase64string(v=vs.110).aspx)
247-
// For an example using an attachment, please see this [use case](https://github.com/sendgrid/sendgrid-csharp/blob/master/USE_CASES.md#attachments).
247+
// For an example using an attachment, please see this [use case](USE_CASES.md#attachments).
248248
msg.AddAttachment("balance_001.pdf",
249249
"base64 encoded string",
250250
"application/pdf",
@@ -271,7 +271,7 @@ namespace Example
271271
};
272272
msg.AddAttachments(attachments);
273273

274-
// For a full transactional template example, please see this [use case](https://github.com/sendgrid/sendgrid-csharp/blob/master/USE_CASES.md#transactional-templates).
274+
// For a full transactional template example, please see this [use case](USE_CASES.md#transactional-templates).
275275
msg.SetTemplateId("d-d42b0eea09964d1ab957c18986c01828");
276276

277277
msg.AddGlobalHeader("X-Day", "Monday");
@@ -858,14 +858,14 @@ var client = new SendGridClient(options);
858858
<a name="domain-authentication"></a>
859859
# How to Setup a Domain Authentication
860860

861-
You can find documentation for how to setup a domain authentication via the UI [here](https://sendgrid.com/docs/ui/account-and-settings/how-to-set-up-domain-authentication/) and via API [here](https://github.com/sendgrid/sendgrid-nodejs/blob/master/packages/client/USAGE.md#sender-authentication).
861+
You can find documentation for how to setup a domain authentication via the UI [here](https://sendgrid.com/docs/ui/account-and-settings/how-to-set-up-domain-authentication/) and via API [here](USAGE.md#sender-authentication).
862862

863863
Find more information about all of SendGrid's authentication related documentation [here](https://sendgrid.com/docs/ui/account-and-settings/).
864864

865865
<a name="email-stats"></a>
866866
# How to View Email Statistics
867867

868-
You can find documentation for how to view your email statistics via the UI [here](https://app.sendgrid.com/statistics) and via API [here](https://github.com/sendgrid/sendgrid-csharp/blob/master/USAGE.md#stats).
868+
You can find documentation for how to view your email statistics via the UI [here](https://app.sendgrid.com/statistics) and via API [here](USAGE.md#stats).
869869

870870
Alternatively, we can post events to a URL of your choice via our [Event Webhook](https://sendgrid.com/docs/API_Reference/Webhooks/event.html) about events that occur as Twilio SendGrid processes your email.
871871

examples/eventwebhook/consumer/Src/EventWebhook/Views/EventWebhook/Index.cshtml

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,5 @@
55

66
<h1>You have successfully launched the server!</h1>
77
<p>
8-
Check out <a href="https://github.com/sendgrid/sendgrid-csharp/tree/master/examples/eventwebhook/consumer">the documentation</a> on how to use this webhook to utilize the SendGrid Event webhook.
8+
Check out <a href="https://github.com/sendgrid/sendgrid-csharp/tree/HEAD/examples/eventwebhook/consumer">the documentation</a> on how to use this webhook to utilize the SendGrid Event webhook.
99
</p>

examples/mail/mail.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
////////////////////////////////////////////////////////
3232
// v3 Mail Send
3333
// POST /mail/send
34-
// This endpoint has a helper, check it out [here](https://github.com/sendgrid/sendgrid-csharp/blob/master/src/SendGrid/Helpers/Mail/README.md).
34+
// This endpoint has a helper, check it out [here](https://github.com/sendgrid/sendgrid-csharp/blob/HEAD/src/SendGrid/Helpers/Mail/README.md).
3535

3636
string data = @"{
3737
'asm': {

src/SendGrid/Helpers/Mail/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
# Quick Start
44

5-
Run the [Example Project](https://github.com/sendgrid/sendgrid-csharp/tree/master/ExampleCoreProject) (make sure you have set your Environment variable to include your SENDGRID_API_KEY).
5+
Run the [Example Project](../../../../ExampleCoreProject) (make sure you have set your Environment variable to include your SENDGRID_API_KEY).
66

77
Click on the Example project, then click the `Start` button in the menu.
88

99
## Usage
1010

11-
- See the [example](https://github.com/sendgrid/sendgrid-csharp/tree/master/ExampleCoreProject/Example.cs) for a complete working example.
11+
- See the [example](../../../../ExampleCoreProject/Program.cs) for a complete working example.
1212
- [Documentation](https://sendgrid.com/docs/API_Reference/Web_API_v3/Mail/index.html)

twilio_sendgrid_logo.png

14.3 KB
Loading

0 commit comments

Comments
 (0)