Skip to content

Commit

Permalink
[semver:skip] Fix README.md and documentation (#2)
Browse files Browse the repository at this point in the history
  • Loading branch information
knanao authored Jan 7, 2022
1 parent fac22e6 commit e0de1e7
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 3 deletions.
2 changes: 1 addition & 1 deletion .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ workflows:
add-pr-comment: false
fail-if-semver-not-indicated: true
publish-version-tag: true
ssh-fingerprints: 16:ba:d2:80:20:18:af:bf:d4:62:6b:79:1c:65:00:00
ssh-fingerprints: ae:55:e3:45:d8:fb:1e:92:2b:5c:de:40:58:7e:ef:4c
requires:
- test
filters:
Expand Down
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,23 @@ Orb for interacting with PipeCD on CircleCI. See: [the documentation](https://pi
# Usage
Explore the src/examples directories to get an idea of how this works. If you feel there is something we could clarify, please let us know!
_For full usage guidelines, see the [orb registry listing](https://circleci.com/developer/orbs/orb/pipe-cd/pipecd)._

# Contributing
We welcome [issues](https://github.com/pipe-cd/orb-pipecd/issues) to and [pull requests](https://github.com/pipe-cd/orb-pipecd/pulls) against this repository!

## How to Publish
* Create and push a branch with your new features.
* When ready to publish a new production version, create a Pull Request from _feature branch_ to `master`.
* The title of the pull request must contain a special semver tag: `[semver:<segement>]` where `<segment>` is replaced by one of the following values.

| Increment | Description|
| ----------| -----------|
| major | Issue a 1.0.0 incremented release|
| minor | Issue a x.1.0 incremented release|
| patch | Issue a x.x.1 incremented release|
| skip | Do not issue a release|

Example: `[semver:major]`

* Squash and merge. Ensure the semver tag is preserved and entered as a part of the commit message.
* On merge, after manual approval, the orb will automatically be published to the Orb Registry.
2 changes: 0 additions & 2 deletions src/commands/event-register.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,10 @@ parameters:

event-name:
type: string
default: ''
description: The event name.

data:
type: string
default: ''
description: The event data.

labels:
Expand Down

0 comments on commit e0de1e7

Please sign in to comment.