Skip to content

Commit

Permalink
chore: Add release please to automate version and changelog updates
Browse files Browse the repository at this point in the history
chore: Add release please to automate version and changelog updates
  • Loading branch information
musale authored Oct 22, 2024
2 parents 04fec44 + 59a967e commit 968112a
Show file tree
Hide file tree
Showing 7 changed files with 71 additions and 17 deletions.
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
2 changes: 1 addition & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ jobs:
run: exit 1

publish-npm:
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' && !contains(github.event.head_commit.message, 'auto dependabot') }}
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' && github.actor == 'release-please[bot]'}}
needs: build
environment:
name: production_feed
Expand Down
3 changes: 3 additions & 0 deletions .release-please-manifest.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
".": "1.0.0-preview.27"
}
35 changes: 34 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,40 @@
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.

## Pull requests
All pull requests should be submitted against the **dev** branch or a specific feature branch.
All pull requests should be submitted against the **main** branch or a specific feature branch. The `main` branch is intended to represent the code released in the most-recent npm package.

When a new package is about to be released, the release PR will be merged into `main`. The package will be generated from `main`.

## 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 miscellaneous non-sdk changes in the repo e.g. removing an unused file

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

Some things to note about this project:

Expand Down
2 changes: 2 additions & 0 deletions packages/msgraph-beta-sdk/version.ts
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
// x-release-please-start-version
export const version = "1.0.0-preview.10";
// x-release-please-end
28 changes: 28 additions & 0 deletions release-please-config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
{
"bootstrap-sha": "73cd29789d538494d3b9d7a7922c26aad7243ddd",
"$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json",
"pull-request-header": ":rocket: A new MSGraph Beta TypeScript SDK release is coming up!",
"include-component-in-tag": false,
"versioning": "prerelease",
"packages": {
".": {
"changelog-path": "CHANGELOG.md",
"release-type": "node",
"bump-minor-pre-major": false,
"bump-patch-for-minor-pre-major": false,
"include-v-in-tag": true,
"draft": false,
"prerelease": true
}
},
"extra-files": [
"lerna.json",
{
"type": "json",
"path": "packages/**/*/package.json",
"glob": true,
"jsonpath": "$.version"
},
"packages/msgraph-beta-sdk/version.ts"
]
}
15 changes: 0 additions & 15 deletions scripts/incrementMinorVersion.ps1

This file was deleted.

0 comments on commit 968112a

Please sign in to comment.