Skip to content

Commit db5afa2

Browse files
chore: update GitHub branch references to use HEAD (#644)
1 parent 7e64e54 commit db5afa2

File tree

11 files changed

+31
-50
lines changed

11 files changed

+31
-50
lines changed

CHANGELOG.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ All notable changes to this project will be documented in this file.
114114

115115
## [4.4.0] - 2019-05-20
116116
### Added
117-
- [PR #500](https://github.com/sendgrid/sendgrid-java/pull/500/files): Update CONTRIBUTING.md - using gitflow workflow, development branch instead of master -- BIG thanks to [Alex](https://github.com/pushkyn)
117+
- [PR #500](https://github.com/sendgrid/sendgrid-java/pull/500/files): Update CONTRIBUTING.md - using gitflow workflow, development branch instead of main -- BIG thanks to [Alex](https://github.com/pushkyn)
118118
- [PR #521](https://github.com/sendgrid/sendgrid-java/pull/521/files): Updating prerequisites -- BIG thanks to [Rishabh](https://github.com/Rishabh04-02)
119119
- [PR #495](https://github.com/sendgrid/sendgrid-java/pull/495/files): Add ability to impersonate subusers -- BIG thanks to [Rohit Tarachandani](https://github.com/Rohit-T)
120120
- [PR #569](https://github.com/sendgrid/sendgrid-java/pull/495/files): Twilio Branding + CLA Policy Update
@@ -231,7 +231,7 @@ request.addQueryParam("limit", "1");
231231
## [3.0.9] - 2016-08-24
232232
### Added
233233
- Table of Contents in the README
234-
- Added a [USE_CASES.md](https://github.com/sendgrid/sendgrid-java/blob/master/USE_CASES.md) section, with the first use case example for transactional templates
234+
- Added a [USE_CASES.md](USE_CASES.md) section, with the first use case example for transactional templates
235235

236236
## [3.0.8] - 2016-08-09
237237
### Fixed
@@ -250,7 +250,7 @@ request.addQueryParam("limit", "1");
250250

251251
## [3.0.6] - 2016-07-26
252252
### Added
253-
- [Troubleshooting](https://github.com/sendgrid/sendgrid-python/blob/master/TROUBLESHOOTING.md) section
253+
- [Troubleshooting](TROUBLESHOOTING.md) section
254254

255255
## [3.0.5] - 2016-07-20
256256
### Added

CONTRIBUTING.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ source ./sendgrid.env
8888

8989
##### Execute: #####
9090

91-
See the [examples folder](https://github.com/sendgrid/sendgrid-java/tree/master/examples) to get started quickly.
91+
See the [examples folder](examples) to get started quickly.
9292

9393
Check out the documentation for [Web API v3 endpoints](https://sendgrid.com/docs/API_Reference/Web_API_v3/index.html).
9494

@@ -124,9 +124,9 @@ The interface to the Twilio SendGrid API.
124124

125125
All PRs require passing tests before the PR will be reviewed.
126126

127-
All test files are in the [`tests`](https://github.com/sendgrid/sendgrid-java/tree/master/src/test/java/com/sendgrid) directory.
127+
All test files are in the [`tests`](src/test/java/com/sendgrid) directory.
128128

129-
For the purposes of contributing to this repo, please update the [`SendGridTest.java`](https://github.com/sendgrid/sendgrid-java/tree/master/src/test/java/com/sendgrid/SendGridTest.java) file with unit tests as you modify the code.
129+
For the purposes of contributing to this repo, please update the [`SendGridTest.java`](src/test/java/com/sendgrid/SendGridTest.java) file with unit tests as you modify the code.
130130

131131
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`.
132132

@@ -196,7 +196,7 @@ Please run your code through:
196196
```
197197

198198
7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
199-
with a clear title and description against the `master` branch. All tests must be passing before we will review the PR.
199+
with a clear title and description against the `main` branch. All tests must be passing before we will review the PR.
200200

201201
## Code Reviews<a name="code-reviews"></a>
202202
If you can, please look at open PRs and review them. Give feedback and help us merge these PRs much faster! If you don't know how, GitHub has some <a href="https://help.github.com/articles/about-pull-request-reviews/">great information on how to review a Pull Request.</a>

README.md

+16-16
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-
[![Travis Badge](https://travis-ci.org/sendgrid/sendgrid-java.svg?branch=master)](https://travis-ci.org/sendgrid/sendgrid-java)
3+
[![Travis Badge](https://travis-ci.org/sendgrid/sendgrid-java.svg?branch=main)](https://travis-ci.org/sendgrid/sendgrid-java)
44
[![Maven Central](https://img.shields.io/maven-central/v/com.sendgrid/sendgrid-java.svg)](http://mvnrepository.com/artifact/com.sendgrid/sendgrid-java)
55
[![Email Notifications Badge](https://dx.sendgrid.com/badge/java)](https://dx.sendgrid.com/newsletter/java)
66
[![Twitter Follow](https://img.shields.io/twitter/follow/sendgrid.svg?style=social&label=Follow)](https://twitter.com/sendgrid)
@@ -16,7 +16,7 @@
1616

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

19-
This library represents the beginning of a new path for Twilio SendGrid. 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-java/issues) and [pull requests](https://github.com/sendgrid/sendgrid-java/blob/master/CONTRIBUTING.md) or simply upvote or comment on existing issues or pull requests.
19+
This library represents the beginning of a new path for Twilio SendGrid. 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-java/issues) and [pull requests](CONTRIBUTING.md) or simply upvote or comment on existing issues or pull requests.
2020

2121
Please browse the rest of this README for further details.
2222

@@ -99,7 +99,7 @@ You can just drop the jar file in. It's a fat jar - it has all the dependencies
9999

100100
## Hello Email
101101

102-
The following is the minimum needed code to send an email with the [/mail/send Helper](https://github.com/sendgrid/sendgrid-java/tree/master/src/main/java/com/sendgrid/helpers) ([here](https://github.com/sendgrid/sendgrid-java/blob/master/examples/helpers/mail/Example.java#L30) is a full example):
102+
The following is the minimum needed code to send an email with the [/mail/send Helper](src/main/java/com/sendgrid/helpers) ([here](examples/helpers/mail/Example.java#L30) is a full example):
103103

104104
### With Mail Helper Class
105105

@@ -132,11 +132,11 @@ public class Example {
132132
}
133133
```
134134

135-
The `Mail` constructor creates a [personalization object](https://sendgrid.com/docs/Classroom/Send/v3_Mail_Send/personalizations.html) for you. [Here](https://github.com/sendgrid/sendgrid-java/blob/master/examples/helpers/mail/Example.java#L221) is an example of how to add to it.
135+
The `Mail` constructor creates a [personalization object](https://sendgrid.com/docs/Classroom/Send/v3_Mail_Send/personalizations.html) for you. [Here](examples/helpers/mail/Example.java#L221) is an example of how to add to it.
136136

137137
### Without Mail Helper Class
138138

139-
The following is the minimum needed code to send an email without the /mail/send Helper ([here](https://github.com/sendgrid/sendgrid-java/blob/master/examples/mail/mail.java#L54) is a full example):
139+
The following is the minimum needed code to send an email without the /mail/send Helper ([here](examples/mail/mail.java#L54) is a full example):
140140

141141
```java
142142
import com.sendgrid.*;
@@ -189,23 +189,23 @@ public class Example {
189189
# Usage
190190

191191
- [Twilio SendGrid Docs](https://sendgrid.com/docs/API_Reference/Web_API_v3/index.html)
192-
- [Library Usage Docs](https://github.com/sendgrid/sendgrid-java/tree/master/USAGE.md)
193-
- [Example Code](https://github.com/sendgrid/sendgrid-java/tree/master/examples)
192+
- [Library Usage Docs](USAGE.md)
193+
- [Example Code](examples)
194194
- [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)
195-
- [v3 Web API Mail Send Helper](https://github.com/sendgrid/sendgrid-java/tree/master/src/main/java/com/sendgrid/helpers) - build a request object payload for a v3 /mail/send API call.
195+
- [v3 Web API Mail Send Helper](src/main/java/com/sendgrid/helpers) - build a request object payload for a v3 /mail/send API call.
196196

197197

198198
<a name="use-cases"></a>
199199
# Use Cases
200200

201-
[Examples of common API use cases](https://github.com/sendgrid/sendgrid-java/blob/master/USE_CASES.md), such as how to send an email with a transactional template.
201+
[Examples of common API use cases](USE_CASES.md), such as how to send an email with a transactional template.
202202

203203
<a name="announcements"></a>
204204
# Announcements
205205

206206
Please see our announcement regarding [breaking changes](https://github.com/sendgrid/sendgrid-java/issues/140). Your support is appreciated!
207207

208-
All updates to this library are documented in our [CHANGELOG](https://github.com/sendgrid/sendgrid-java/blob/master/CHANGELOG.md) and [releases](https://github.com/sendgrid/sendgrid-java/releases). You may also subscribe to email [release notifications](https://dx.sendgrid.com/newsletter/java) for releases and breaking changes.
208+
All updates to this library are documented in our [CHANGELOG](CHANGELOG.md) and [releases](https://github.com/sendgrid/sendgrid-java/releases). You may also subscribe to email [release notifications](https://dx.sendgrid.com/newsletter/java) for releases and breaking changes.
209209

210210
<a name="roadmap"></a>
211211
# Roadmap
@@ -215,18 +215,18 @@ If you are interested in the future direction of this project, please take a loo
215215
<a name="contribute"></a>
216216
# How to Contribute
217217

218-
We encourage contribution to our libraries (you might even score some nifty swag), please see our [CONTRIBUTING](https://github.com/sendgrid/sendgrid-java/blob/master/CONTRIBUTING.md) guide for details.
218+
We encourage contribution to our libraries (you might even score some nifty swag), please see our [CONTRIBUTING](CONTRIBUTING.md) guide for details.
219219

220220
Quick links:
221221

222-
- [Feature Request](https://github.com/sendgrid/sendgrid-java/blob/master/CONTRIBUTING.md#feature-request)
223-
- [Bug Reports](https://github.com/sendgrid/sendgrid-java/blob/master/CONTRIBUTING.md#submit-a-bug-report)
224-
- [Improvements to the Codebase](https://github.com/sendgrid/sendgrid-java/blob/master/CONTRIBUTING.md#improvements-to-the-codebase)
222+
- [Feature Request](CONTRIBUTING.md#feature-request)
223+
- [Bug Reports](CONTRIBUTING.md#submit-a-bug-report)
224+
- [Improvements to the Codebase](CONTRIBUTING.md#improvements-to-the-codebase)
225225

226226
<a name="troubleshooting"></a>
227227
# Troubleshooting
228228

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

231231
<a name="about"></a>
232232
# About

TROUBLESHOOTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ You can just drop the jar file in. It's a fat jar - it has all the dependencies
6060
<a name="versions"></a>
6161
## Versions
6262

63-
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-java/blob/master/CHANGELOG.md) and [releases](https://github.com/sendgrid/sendgrid-java/releases) section.
63+
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-java/releases) section.
6464

6565
<a name="environment"></a>
6666
## Environment Variables and Your Twilio SendGrid API Key

USAGE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2693,7 +2693,7 @@ For more detailed information about how to use the v3 Mail Send endpoint, please
26932693
26942694
### POST /mail/send
26952695
2696-
This endpoint has a helper, check it out [here](https://github.com/sendgrid/sendgrid-java/blob/master/src/main/java/com/sendgrid/helpers/README.md).
2696+
This endpoint has a helper, check it out [here](src/main/java/com/sendgrid/helpers/README.md).
26972697
26982698
```java
26992699
try {

USE_CASES.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -223,13 +223,13 @@ public class Example {
223223
<a name="domain-authentication"></a>
224224
# How to Setup a Domain Authentication
225225

226-
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).
226+
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).
227227

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

230230
# How to View Email Statistics
231231

232-
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-java/blob/master/USAGE.md#stats).
232+
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).
233233

234234
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.
235235

bin/com/sendgrid/helpers/README.md

-19
This file was deleted.

examples/mail/mail.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ public static void main(String[] args) throws IOException {
5555
// v3 Mail Send
5656
// POST /mail/send
5757

58-
// This endpoint has a helper, check it out [here](https://github.com/sendgrid/sendgrid-java/blob/master/src/main/java/com/sendgrid/helpers/README.md).
58+
// This endpoint has a helper, check it out [here](https://github.com/sendgrid/sendgrid-java/blob/HEAD/src/main/java/com/sendgrid/helpers/README.md).
5959

6060
public class Example {
6161
public static void main(String[] args) throws IOException {

pom.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
<licenses>
1616
<license>
1717
<name>The MIT License (MIT)</name>
18-
<url>https://github.com/sendgrid/java-http-client/blob/master/LICENSE</url>
18+
<url>https://github.com/sendgrid/java-http-client/blob/HEAD/LICENSE</url>
1919
<distribution>repo</distribution>
2020
</license>
2121
</licenses>

src/main/java/com/sendgrid/helpers/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
# Quick Start
88

9-
Run the [example](https://github.com/sendgrid/sendgrid-java/tree/master/examples/mail) (make sure you have set your environment variable to include your SENDGRID_API_KEY).
9+
Run the [example](../../../../../../examples/mail) (make sure you have set your environment variable to include your SENDGRID_API_KEY).
1010

1111
```bash
1212
cd examples/mail
@@ -15,5 +15,5 @@ javac -classpath ../../build/libs/sendgrid-4.2.1-jar.jar:. Example.java && java
1515

1616
## Usage
1717

18-
- See the [example](https://github.com/sendgrid/sendgrid-java/tree/master/examples/mail) for a complete working example.
18+
- See the [example](../../../../../../examples/mail) for a complete working example.
1919
- [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)