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

Bips 16468 release please #5

Merged
merged 4 commits into from
Feb 14, 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
1 change: 1 addition & 0 deletions .github/release.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
releaseType: simple
Empty file added CHANGELOG.md
Empty file.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,22 @@
# go-client-library-passwordsafe
This Go client library makes it easier to access Password Safe APIs. Provide simplifications that significantly reduce the amount of code you need to write.

## Release Please App usage

In order to use Release Please App, we need to use [Conventional commits](https://beyondtrust.atlassian.net/wiki/spaces/DEVOPS/pages/380699165/Releasing+Software#4.-Trigger-the-app), but [here](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#type) is a more comprehensive guide about some conventional commits that we can use.

Some of the more important and common commit types are:

|Type |Description |Triggers Release Please|
|:-------|:------------------------------------------------------------|:----------------------|
|feat! |Introduce a major change e.g. v1.0.0 to v2.0.0 |Yes |
|feat |Introduce a minor change e.g. v1.0.0 to v1.1.0 |Yes |
|fix |Introduce a patch change e.g. v1.0.0 to v1.0.1 |Yes |
Copy link
Contributor

Choose a reason for hiding this comment

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

Ivan, could you set the release please version to be 0.0.0 to start with? just while we are developing the library.

When we are finished we will change it to a 1.0.0 version

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ok, so going to change the release type to simple to get into version 0.0.0, that can be our best option.

|chore |Could introduce a BREAKING CHANGE into the CHANGELOG |Yes |
|docs |Documentation update |No |
|refactor|A code change that neither fixes a bug nor adds a feature |No |
|test |Adding or modifying tests |No |
|build |Changes that affect the build system or external dependencies|No |
|ci |Changes to CI configuration files and scripts |No |

Remember, Release Please App will trigger once a PR with the conventional commit structure are merged into the main branch, so if you are working on features that are related to a Jira ticket, you can still use **feat** while developing, and because we can squash the commits once we want to merge the PR, only one commit with the conventional syntax will be on the history and on the changelog.
Empty file added version.txt
Empty file.
Loading