-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: Add DEVELOPMENT_MAINTENANCE.md doc
- Loading branch information
1 parent
eb351da
commit 3b70ce9
Showing
3 changed files
with
27 additions
and
27 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# UDS Bundle Software Factory Nutanix | ||
|
||
## Creating Releases | ||
|
||
This project uses [release-please-action](https://github.com/google-github-actions/release-please-action) for versioning and releasing OCI packages. | ||
|
||
### How should I write my commits? | ||
|
||
Release Please assumes you are using [Conventional Commit messages](https://www.conventionalcommits.org/). | ||
|
||
The most important prefixes you should have in mind are: | ||
|
||
- `fix:` which represents bug fixes, and correlates to a [SemVer](https://semver.org/) | ||
patch. | ||
- `feat:` which represents a new feature, and correlates to a SemVer minor. | ||
- `feat!:`, or `fix!:`, `refactor!:`, etc., which represent a breaking change | ||
(indicated by the `!`) and will result in a SemVer major. | ||
|
||
When changes are merged to the `main` branch, the Release Please will evaluate all commits since the previous release to calculate what changes are included and will create another PR to increase the version and tag a new release (per the Release Please design [documentation](https://github.com/googleapis/release-please/blob/main/docs/design.md#lifecycle-of-a-release)). This will also automatically generate changelog entries based on these commits. | ||
|
||
> TIP: Merging a PR should be done via a branch **"Squash and merge"**; this means that the commit message seen on this PR merge is what Release Please will use to determine a version bump. | ||
When the auto generated Release Please PR is merged the following steps will automatically happen. | ||
1) A new release will be created and tagged | ||
1) A new bundle artifact will be published to the OCI registry. |