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

Add config for release please. #1532

Merged
merged 13 commits into from
May 24, 2024
Merged
3 changes: 3 additions & 0 deletions .github/release-please.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
manifest: true
primaryBranch: main
handleGHRelease: true
3 changes: 3 additions & 0 deletions .release-please-manifest.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
".": "2.10.0"
}
31 changes: 31 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,37 @@ There are a few different recommended paths to get contributions into the releas
## File issues
The best way to get started with a contribution is to start a dialog with us. Sometimes features will be under development or out of scope for this library and it's best to check before starting work on contribution, especially for large work items.

## Commit message format

To support our automated release process, pull requests are required to follow the [Conventional Commit](https://www.conventionalcommits.org/en/v1.0.0/)
format.

Each commit message consists of a **header**, an optional **body** and an optional **footer**. The header is the first line of the commit and
MUST have a **type** (see below for a list of types) and a **description**. An optional **scope** can be added to the header to give extra context.

```
<type>[optional scope]: <short description>
<BLANK LINE>
<optional body>
<BLANK LINE>
<optional footer(s)>
```

The recommended commit types used are:

- **feat** for feature updates (increments the _minor_ version)
- **fix** for bug fixes (increments the _patch_ version)
- **perf** for performance related changes e.g. optimizing an algorithm
- **refactor** for code refactoring changes
- **test** for test suite updates e.g. adding a test or fixing a test
- **style** for changes that don't affect the meaning of code. e.g. formatting changes
- **docs** for documentation updates e.g. ReadMe update or code documentation updates
- **build** for build system changes (gradle updates, external dependency updates)
- **ci** for CI configuration file changes e.g. updating a pipeline
- **chore** for miscallaneous non-sdk changesin the repo e.g. removing an unused file

Adding a footer with the prefix **BREAKING CHANGE:** will cause an increment of the _major_ version.

## Pull requests
If you are making documentation changes, feel free to submit a pull request against the **main** branch. All other pull requests should be submitted against the **dev** branch or a specific feature branch. The master branch is intended to represent the code released in the most-recent composer package.

Expand Down
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,12 @@

## Install the SDK
You can install the PHP SDK with Composer by editing your `composer.json` file:
```
```json5
SilasKenneth marked this conversation as resolved.
Show resolved Hide resolved
{
"require": {
// x-release-please-start-version
"microsoft/microsoft-graph": "^2.10.0"
// x-release-please-end-->
}
}
```
Expand Down
26 changes: 26 additions & 0 deletions release-please-config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
{
"bootstrap-sha": "272035ede24db5978797f441cd0bc1b1c58af836",
"exclude-paths": [
".git",
".idea",
".github",
".vscode",
"tests",
"scripts"
],
"release-type": "simple",
"include-component-in-tag": false,
"include-v-in-tag": true,
"changelog-type": "github",
"packages": {
".": {
"package-name": "microsoft/microsoft-graph",
"changelog-path": "CHANGELOG.md",
"extra-files": [
"src/GraphConstants.php",
"README.md"
]
}
},
"$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json"
}
2 changes: 2 additions & 0 deletions src/GraphConstants.php
Original file line number Diff line number Diff line change
Expand Up @@ -19,5 +19,7 @@
final class GraphConstants
{
const API_VERSION = "v1.0";
// x-release-please-start-version
const SDK_VERSION = "2.10.0";
// x-release-please-end
}