Skip to content

Commit 803e357

Browse files
chore: update GitHub branch references to use HEAD (#128)
1 parent 5b113ce commit 803e357

File tree

7 files changed

+18
-18
lines changed

7 files changed

+18
-18
lines changed

CONTRIBUTING.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ We welcome direct contributions to the java-http-client code base. Thank you!
5050
##### Prerequisites #####
5151

5252
- Java 8 or 11
53-
- Please see [build.gradle](https://github.com/sendgrid/java-http-client/blob/master/build.gradle)
53+
- Please see [pom.xml](pom.xml)
5454

5555
##### Initial setup: #####
5656

@@ -61,7 +61,7 @@ cd java-http-client
6161

6262
##### Execute: #####
6363

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

6666
You will need to setup the following environment to use the SendGrid example:
6767

@@ -105,9 +105,9 @@ Provides a standard interface to an API's response.
105105

106106
All PRs require passing tests before the PR will be reviewed.
107107

108-
All test files are in [`java-http-client/src/test/java/com/sendgrid`](https://github.com/sendgrid/java-http-client/tree/master/src/test/java/com/sendgrid).
108+
All test files are in [`java-http-client/src/test/java/com/sendgrid`](src/test/java/com/sendgrid).
109109

110-
For the purposes of contributing to this repo, please update the [`ClientTest.java`](https://github.com/sendgrid/java-http-client/blob/master/src/test/java/com/sendgrid/ClientTest.java) file with unit tests as you modify the code.
110+
For the purposes of contributing to this repo, please update the [`ClientTest.java`](src/test/java/com/sendgrid/ClientTest.java) file with unit tests as you modify the code.
111111

112112

113113
Run the tests:
@@ -168,7 +168,7 @@ Please run your code through:
168168
5. Locally merge (or rebase) the upstream development branch into your topic branch:
169169

170170
```bash
171-
git pull [--rebase] upstream master
171+
git pull [--rebase] upstream main
172172
```
173173

174174
6. Push your topic branch up to your fork:
@@ -178,7 +178,7 @@ Please run your code through:
178178
```
179179

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

183183
## Code Reviews
184184
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 great [information on how to review a Pull Request](https://help.github.com/articles/about-pull-request-reviews/).

README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
![SendGrid Logo](https://uiux.s3.amazonaws.com/2016-logos/email-logo%402x.png)
1+
![SendGrid Logo](twilio_sendgrid_logo.png)
22

3-
[![Build Status](https://travis-ci.org/sendgrid/java-http-client.svg?branch=master)](https://travis-ci.org/sendgrid/java-http-client)
3+
[![Build Status](https://travis-ci.org/sendgrid/java-http-client.svg?branch=main)](https://travis-ci.org/sendgrid/java-http-client)
44
[![Maven Central](https://img.shields.io/maven-central/v/com.sendgrid/java-http-client.svg)](http://mvnrepository.com/artifact/com.sendgrid/java-http-client)
55
[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE.md)
66
[![Twitter Follow](https://img.shields.io/twitter/follow/sendgrid.svg?style=social&label=Follow)](https://twitter.com/sendgrid)
@@ -25,7 +25,7 @@ If you are looking for the SendGrid API client library, please see [this repo](h
2525
# Announcements
2626
**The default branch name for this repository has been changed to `main` as of 07/27/2020.**
2727

28-
All updates to this project are documented in our [CHANGELOG](https://github.com/sendgrid/java-http-client/blob/master/CHANGELOG.md).
28+
All updates to this project are documented in our [CHANGELOG](CHANGELOG.md).
2929

3030
<a name="installation"></a>
3131
# Installation
@@ -67,7 +67,7 @@ repositories {
6767

6868
## Dependencies
6969

70-
- Please see the [build.gradle file](https://github.com/sendgrid/java-http-client/blob/master/build.gradle)
70+
- Please see the [pom.xml file](pom.xml)
7171

7272
<a name="quick-start"></a>
7373
# Quick Start
@@ -124,7 +124,7 @@ If you are interested in the future direction of this project, please take a loo
124124
<a name="contribute"></a>
125125
# How to Contribute
126126

127-
We encourage contribution to our projects please see our [CONTRIBUTING](https://github.com/sendgrid/java-http-client/blob/master/CONTRIBUTING.md) guide for details.
127+
We encourage contribution to our projects please see our [CONTRIBUTING](CONTRIBUTING.md) guide for details.
128128

129129
Quick links:
130130

USAGE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Usage
22

3-
- [Example Code](https://github.com/sendgrid/java-http-client/tree/master/examples)
3+
- [Example Code](examples)
44

55
The example uses SendGrid, you can get your free account [here](https://sendgrid.com/free?source=java-http-client).
66

docker/Dockerfile

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
FROM store/oracle/serverjre:8
22

3-
ENV OAI_SPEC_URL="https://github.com/raw/sendgrid/sendgrid-oai/master/oai_stoplight.json"
3+
ENV OAI_SPEC_URL="https://github.com/raw/sendgrid/sendgrid-oai/HEAD/oai_stoplight.json"
44

55
RUN yum install -y git
66

77
WORKDIR /root
88

99
# install Prism
10-
ADD https://github.com/raw/stoplightio/prism/master/install.sh install.sh
10+
ADD https://github.com/raw/stoplightio/prism/HEAD/install.sh install.sh
1111
RUN chmod +x ./install.sh && sync && \
1212
./install.sh && \
1313
rm ./install.sh

docker/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Supported tags and respective `Dockerfile` links
2-
- `v1.0.0`, `latest` [(Dockerfile)](https://github.com/sendgrid/java-http-client/blob/master/docker/Dockerfile)
2+
- `v1.0.0`, `latest` [(Dockerfile)](Dockerfile)
33

44
# Quick reference
55
Due to Oracle's JDK license, you must build this Docker image using the official Oracle image located in the Docker Store. You will need a Docker store account. Once you have an account, you must accept the Oracle license [here](https://store.docker.com/images/oracle-serverjre-8). On the command line, type `docker login` and provide your credentials. You may then build the image using this command `docker build -t sendgrid/java-http-client -f Dockerfile .`
@@ -11,7 +11,7 @@ Due to Oracle's JDK license, you must build this Docker image using the official
1111
https://github.com/sendgrid/java-http-client/issues
1212

1313
- **Where to get more info:**
14-
[USAGE.md](https://github.com/sendgrid/java-http-client/blob/master/docker/USAGE.md)
14+
[USAGE.md](USAGE.md)
1515

1616
- **Maintained by:**
1717
[SendGrid Inc.](https://sendgrid.com)
@@ -26,6 +26,6 @@ Due to Oracle's JDK license, you must build this Docker image using the official
2626
$ docker run -it -v /path/to/cool-java-http-client:/mnt/java-http-client sendgrid/java-http-client
2727
```
2828

29-
For more detailed information, see [USAGE.md](https://github.com/sendgrid/java-http-client/blob/master/docker/USAGE.md).
29+
For more detailed information, see [USAGE.md](USAGE.md).
3030

3131
![SendGrid Logo](https://uiux.s3.amazonaws.com/2016-logos/email-logo%402x.png)

pom.xml

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

twilio_sendgrid_logo.png

14.3 KB
Loading

0 commit comments

Comments
 (0)