Skip to content

Commit

Permalink
add missing approval doc (#244)
Browse files Browse the repository at this point in the history
  • Loading branch information
karen-stepanyan authored Feb 19, 2024
1 parent d0d6323 commit 042f02b
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ yarn test

### Automatic

The normal flow for publishing a release is through a series o GitHub actions that are triggered when a PR is closed by merging with the base branch. Full details about our workflows can be found in [./.github/WORKFLOW-README.MD]. A summary of our publish workflow follows:
The normal flow for publishing a release is through a series o GitHub actions that are triggered when a PR is closed by merging with the base branch. Full details about our workflows can be found in [docs](./docs/github_workflows.md). A summary of our publish workflow follows:

1. Close a PR containing your changes
2. If the PR was merged and if it contains a version label instruction (patch, minor, major, none), a new PR will be created that contains the result of running `npm version LABEL` on main with the original PR author assigned as a reviewer.
Expand Down
2 changes: 1 addition & 1 deletion docs/github_workflows.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ This job is responsible for creating a new pull request with a version bump comm

### [publish](../.github/workflows/publish.yaml)

The publish workflow is used to publish an NPM package when changes (version-bump pull requests) are pushed to the main branch and the package.json file is updated.
The publish workflow is used to publish an NPM package when changes (version-bump pull requests) are pushed to the main branch and the package.json file is updated. **Requires an engineer to approve the use of production credentials.**
The workflow ensures that the current package version is different from the previously published version before initiating the publishing process.

#### Trigger Events
Expand Down

0 comments on commit 042f02b

Please sign in to comment.