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

feat: Allows publishing npm versions from feature branches #186

Merged
merged 7 commits into from
Apr 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
# [1.11.0-release-process.1](https://github.com/mParticle/aquarium/compare/v1.10.0...v1.11.0-release-process.1) (2024-03-29)


### Features

* allows publishing from feature branches ([eb32f58](https://github.com/mParticle/aquarium/commit/eb32f58e8b616c27c51a081e56e4e8f8d751a171))

# [1.10.0](https://github.com/mParticle/aquarium/compare/v1.9.5...v1.10.0) (2024-03-29)


Expand Down
11 changes: 4 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,14 +34,11 @@ yarn add https://github.com/mParticle/aquarium#<branch-name>

We use semantic-release for releasing new versions of the library.

## Releasing development versions
## Releasing feature versions

To test development version of the Aquarium we use the `dev` branch on Github and `dev` distribution channel on npm.
This allows us to install a version of the library by running the following command:

```
yarn add @mparticle/aquarium@dev
```
To test feature versions of the Aquarium we use `feat/` branchs on Github and the `feature` distribution channel on npm.
This allows us to release specific versions for testing specific features and install them on the platforms. To release it,
just run the Github Action from the `feat/` branch you want to release.

## Commit conventions and PR titles

Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@mparticle/aquarium",
"version": "1.10.0",
"version": "1.11.0-release-process.1",
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will be updated as soon as we release a new version from main, but it makes me wonder if this should go into main? Probably not.

Copy link
Collaborator Author

@tibuurcio tibuurcio Apr 16, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It actually makes sense. The newest version we will have once this reaches main is this one. And once we release a new one from main, that's gonna be updated. All good I think.

"description": "mParticle Component Library",
"license": "Apache-2.0",
"keywords": [
Expand Down
6 changes: 5 additions & 1 deletion release.config.cjs
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
module.exports = {
branches: ['main', { name: 'dev', channel: 'dev', prerelease: 'dev' }],
branches: ['main', {
name: 'feat/*',
channel: 'feature',
prerelease: "${name.split('/').slice(1).join('-').toLowerCase()}"
}],
tagFormat: 'v${version}',
repositoryUrl: 'https://github.com/mParticle/aquarium',
plugins: [
Expand Down
Loading