Skip to content

Commit

Permalink
chore: Add DEVELOPMENT_MAINTENANCE.md doc
Browse files Browse the repository at this point in the history
  • Loading branch information
anthonywendt committed Dec 1, 2023
1 parent eb351da commit 3b70ce9
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 27 deletions.
27 changes: 0 additions & 27 deletions CONTRIBUTING.md

This file was deleted.

2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,5 @@ A UDS Bundle Containing
- confluence
- mattermost
- nexus

[DEVELOPMENT_MAINTENANCE.md](docs/DEVELOPMENT_MAINTENANCE.md)
25 changes: 25 additions & 0 deletions docs/DEVELOPMENT_MAINTENANCE.md
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.

0 comments on commit 3b70ce9

Please sign in to comment.