Skip to content

chore: update GitHub branch references to use HEAD #128

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Aug 14, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ We welcome direct contributions to the java-http-client code base. Thank you!
##### Prerequisites #####

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

##### Initial setup: #####

Expand All @@ -61,7 +61,7 @@ cd java-http-client

##### Execute: #####

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

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

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

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

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).
All test files are in [`java-http-client/src/test/java/com/sendgrid`](src/test/java/com/sendgrid).

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


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

```bash
git pull [--rebase] upstream master
git pull [--rebase] upstream main
```

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

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

## Code Reviews
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/).
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
![SendGrid Logo](https://uiux.s3.amazonaws.com/2016-logos/email-logo%402x.png)
![SendGrid Logo](twilio_sendgrid_logo.png)

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

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

<a name="installation"></a>
# Installation
Expand Down Expand Up @@ -67,7 +67,7 @@ repositories {

## Dependencies

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

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

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

Quick links:

Expand Down
2 changes: 1 addition & 1 deletion USAGE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Usage

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

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

Expand Down
4 changes: 2 additions & 2 deletions docker/Dockerfile
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
FROM store/oracle/serverjre:8

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

RUN yum install -y git

WORKDIR /root

# install Prism
ADD https://github.com/raw/stoplightio/prism/master/install.sh install.sh
ADD https://github.com/raw/stoplightio/prism/HEAD/install.sh install.sh
RUN chmod +x ./install.sh && sync && \
./install.sh && \
rm ./install.sh
Expand Down
6 changes: 3 additions & 3 deletions docker/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Supported tags and respective `Dockerfile` links
- `v1.0.0`, `latest` [(Dockerfile)](https://github.com/sendgrid/java-http-client/blob/master/docker/Dockerfile)
- `v1.0.0`, `latest` [(Dockerfile)](Dockerfile)

# Quick reference
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 .`
Expand All @@ -11,7 +11,7 @@ Due to Oracle's JDK license, you must build this Docker image using the official
https://github.com/sendgrid/java-http-client/issues

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

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

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

![SendGrid Logo](https://uiux.s3.amazonaws.com/2016-logos/email-logo%402x.png)
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<licenses>
<license>
<name>The MIT License (MIT)</name>
<url>https://github.com/sendgrid/java-http-client/blob/master/LICENSE.md</url>
<url>https://github.com/sendgrid/java-http-client/blob/HEAD/LICENSE.md</url>
<distribution>repo</distribution>
</license>
</licenses>
Expand Down
Binary file added twilio_sendgrid_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.