Skip to content

Commit

Permalink
chore: convert commitlint config to mjs
Browse files Browse the repository at this point in the history
  • Loading branch information
haifeng-li-at-salesforce committed Jun 21, 2024
1 parent 62e8f2d commit 8259f31
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
14 changes: 7 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,18 +74,18 @@ Issues labelled `good first contribution`.

### Branching Strategy:

- **Main Branch**: Ongoing development and new features are submitted to the main branch.
- **Main Branch**: Ongoing development and new features are submitted to the `main` branch.

- **Release Branch**: We'll utilize a dedicated branch for managing releases
- **Release Branches**: We'll utilize dedicated branches for managing releases.

- **Major Release:**
- Create a new branch named `release-\*` (e.g., `release-2`) from `main` to manage the release process.
- Update the `.releaserc.yml` file: Locate the `branches` property and specify the newly created release branch name (e.g., `release-2`).
- Create a new branch named `release-<major version>` (e.g., `release-2` for a `2.0` release) from `main` to manage the release process.
- Update the `.releaserc.json` file: Locate the `branches` property and specify the newly created release branch name (e.g., `release-2`).
- **Minor/Patch Release:**
- If a release branch for a major version already exists (e.g., `release-2`), we can use it for subsequent minor and patch releases.
- Hot fixes are merged in release branch, and will be merged back to `main` once it is verified.
- We will use existing major release branches (e.g. `release-2`) for subsequent minor and patch releases (e.g. `2.0.1`, `2.1.2`, etc.).
- Once changes are verified and merged into the release branch, they will be merged back to `main`.

- **Trigger Release Manually:**:
- **Trigger Release Manually:**
- Navigate to the `Actions` tab in GitHub repository.
- Select the `release` workflow from the left sidebar.
- Click the `Run workflow` button to initiate the release process.
Expand Down
2 changes: 1 addition & 1 deletion commitlint.config.js → commitlint.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
const automaticCommitPattern = /^chore\(release\):.*\[skip ci\]/;

/** @type {import('@commitlint/types').UserConfig} */
module.exports = {
export default {
extends: ['@commitlint/config-conventional'],
ignores: [(commitMsg) => automaticCommitPattern.test(commitMsg)]
};

0 comments on commit 8259f31

Please sign in to comment.