Skip to content
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

TEC-7834 Increment version from 1.0.2 to 1.0.3-SNAPSHOT #52

Merged
merged 3 commits into from Jul 23, 2019
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
12 changes: 11 additions & 1 deletion .github/pull_request_template.md
@@ -1,6 +1,7 @@
### Description of Changes

What has been changed?
What has been changed? If this is more than bug fixes we should consider incrementing the minor
version number. For non backwards compatible changes we need to increment the major version number.

### Documentation

Expand All @@ -17,3 +18,12 @@ How have the changes been tested and the potential risks mitigated?
### Compare (For layered PRs)

Generate compare URL from https://github.com/ebx/ebx-linkedin-sdk/compare so that it's easily accessible. This is ONLY REQUIRED FOR COMPLICATED, DEPENDENT OR LAYERED PRs. Feel free to delete this section if not required.

## Final Checklist

Please tick once completed.

- [ ] Build passes.
- [ ] Versioning considered (the version number in this PR is inline with semantic
versioning requirements).
- [ ] Change log has been updated.
4 changes: 3 additions & 1 deletion CHANGELOG.md
Expand Up @@ -34,4 +34,6 @@
https://developer.linkedin.com/docs/ref/v2/media-migration#migration)
* Add `URNEntityType.UGCPost` and ensure all enums have the string
representation of the urn. Instead of using `URNEntityType.name()`
`URNEntityType.getEntityValue()` should be used to support UGCPosts.
`URNEntityType.getEntityValue()` should be used to support UGCPosts.

## 1.0.3 (Work in progress)
43 changes: 33 additions & 10 deletions README.md
Expand Up @@ -4,7 +4,8 @@

## What it is

ebx-linkedin-sdk is a pure Java LinkedIn API client. It implements the v2 API as described [here](https://docs.microsoft.com/en-us/linkedin/).
ebx-linkedin-sdk is a pure Java LinkedIn API client. It implements the v2 API as described
[here](https://docs.microsoft.com/en-us/linkedin/).

It is created and maintained by [Echobox](http://echobox.com).

Expand All @@ -14,13 +15,14 @@ ebx-linkedin-sdk itself is open source software released under the terms of the

## Installation (Recommended)

Recommended installation is via maven (or gradle etc.). For our latest stable release (recommended) use:
Recommended installation is via maven (or gradle etc.). For our latest stable release (recommended)
use:

```
<dependency>
<groupId>com.echobox</groupId>
<artifactId>ebx-linkedin-sdk</artifactId>
<version>1.0.1</version>
<version>1.0.2</version>
</dependency>
```

Expand All @@ -40,7 +42,8 @@ If you'd like to use the latest SNAPSHOT build please ensure you have snapshots
</repositories>
```

and then include the snapshot dependency, replacing *x.x.x* with the latest [snapshot version](https://github.com/ebx/ebx-linkedin-sdk/blob/dev/pom.xml):
and then include the snapshot dependency, replacing *x.x.x* with the latest
[snapshot version](https://github.com/ebx/ebx-linkedin-sdk/blob/dev/pom.xml):

```
<dependency>
Expand Down Expand Up @@ -90,7 +93,8 @@ To create a LinkedIn Share
shareRequestBody.setText(shareText);
Share share = shareConnection.postShare(shareRequestBody);

Retrieve an organization from LinkedIn ([See documentation](https://docs.microsoft.com/en-us/linkedin/marketing/integrations/community-management/organizations/organization-lookup-api#retrieve-organizations)):
Retrieve an organization from LinkedIn
([See documentation](https://docs.microsoft.com/en-us/linkedin/marketing/integrations/community-management/organizations/organization-lookup-api#retrieve-organizations)):

Organization organization = connection.retrieveOrganization(organizationURN, Parameter
.with("projection",
Expand All @@ -99,16 +103,35 @@ Retrieve an organization from LinkedIn ([See documentation](https://docs.microso

## Getting in touch

* **[GitHub Issues](https://github.com/ebx/ebx-linkedin-sdk/issues/new)**: If you have ideas, bugs, or problems with our library, just open a new issue.
* **[GitHub Issues](https://github.com/ebx/ebx-linkedin-sdk/issues/new)**: If you have ideas, bugs,
or problems with our library, just open a new issue.

## Contributing

If you would like to get involved please follow the instructions [here](https://github.com/ebx/ebx-linkedin-sdk/tree/master/CONTRIBUTING.md)
If you would like to get involved please follow the instructions
[here](https://github.com/ebx/ebx-linkedin-sdk/tree/master/CONTRIBUTING.md)

## Releases

We use [semantic versioning](https://semver.org/).

Each merge into the MASTER branch will automatically get released to maven central, and github releases, using the current library version. As such, following every merge to master, the version number of the dev branch should be incremented and will represent 'Work In Progress' towards the next release.

All merges into DEV will automatically get released as a maven central snapshot, which can be easily included in any downstream dependencies that always desire the latest changes.
All merges into DEV will automatically get released as a maven central snapshot, which can be easily
included in any downstream dependencies that always desire the latest changes (see above for
'Most Up To Date' installation).

Each merge into the MASTER branch will automatically get released to Maven central and github
releases, using the current library version. As such, following every merge to master, the version
number of the dev branch should be incremented and will represent 'Work In Progress' towards the
next release.

To create a full release to Maven central please follow these steps:
1. Ensure the `CHANGELOG.md` is up to date with all the changes in the release, if not please raise
a suitable PR into `DEV`. Typically the change log should be updated as we go.
3. Create a PR from `DEV` into `MASTER`. Ensure the version in the `pom.xml` is the
correct version to be released. Merging this PR into `MASTER` will automatically create the maven
and github releases. Please note that a release is final, it can not be undone/deleted/overwritten.
5. Once the public release has been successful create a final PR into `DEV` that contains an
incremented `pom.xml` version to ensure the correct snapshot gets updated on subsequent merges
into `DEV`. This PR should also include:
* An update to the `README.md` latest stable release version number.
* A 'Work In Progress' entry for the next anticipated release in `CHANGELOG.md`.
2 changes: 1 addition & 1 deletion pom.xml
Expand Up @@ -8,7 +8,7 @@

<groupId>com.echobox</groupId>
<artifactId>ebx-linkedin-sdk</artifactId>
<version>1.0.2</version>
<version>1.0.3</version>
<packaging>jar</packaging>

<properties>
Expand Down