Skip to content
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
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
name: Bug report
about: Create a bug report to help us improve
title: ''
labels: ''
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
List the steps that can be used to demonstrate the bug. Include the name of the service and operation that you're trying to invoke, if applicable. Be sure to describe any relevant info regarding parameter values used with your API invocation.

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Must gather (please complete the following information):**
- SDK Version [e.g. 1.2.1]
- Node Version [e.g. 12.2]
- Name of service that you're trying to use (if applicable)
- Name of operation that you're trying to invoke (if applicable)

**Additional context**
Add any other context about the problem here.
Were you able to avoid the problem by changing your application code slightly?
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
23 changes: 16 additions & 7 deletions docs/pull_request_template.md → .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,27 @@
**Title**: PR Title

**Short Description**: Short explanation/description of PR (or issue/task)

## Checklist

## PR Checklist
Please make sure that your PR fulfills the following requirements:
- [ ] The commit message follows the [Angular Commit Message Guidelines](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-commit-message-guidelines).
- [ ] I have performed a self-review of my changes
- [ ] Tests for the changes have been added (for bug fixes / features)
- [ ] Docs have been added / updated (for bug fixes / features)
- [ ] My code/changes are commented (especially hard-to-understand areas) if they were not autogenerated
- [ ] I have written/updated new integration tests for the core changes or new/updated tests not necessary (`test/integration/key-protect.v2.test.js`)
- [ ] I have posted test results from local tests where relevant, and made sure the TravisCI tests succeeded

## Changes
> _Briefly identify changes made in this PR_
<!-- BEGIN CHANGES -->
## Current vs new behavior
<!-- Please describe the current behavior that you are modifying and the new behavior. -->

## Does this PR introduce a breaking change?
- [ ] Yes
- [ ] No

<!-- If this PR contains a breaking change, please describe the impact and migration path for existing applications below. -->

<!-- END CHANGES -->
## Other information
<!-- Please add any additional information that would help reviewers evaluate your PR -->

## Test Results

Expand Down
104 changes: 104 additions & 0 deletions .github/workflows/build.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
# This workflow will build and unit test the project.
# If the workflow is running on the "main" branch, then
# semantic-release is also run to create a new release (if
# warranted by the new commits being built).

name: build

on:
push:
branches: ['**']
pull_request:
branches: ['**']
workflow_dispatch:
# Allow workflow to be triggered manually.

jobs:
detect-secrets:
if: "!contains(github.event.head_commit.message, '[skip ci]')"
name: detect-secrets
runs-on: ubuntu-latest

steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: 3.12

- name: Install detect-secrets
run: |
pip install --upgrade "git+https://github.com/ibm/detect-secrets.git@master#egg=detect-secrets"

- name: Run detect-secrets
run: |
detect-secrets scan --update .secrets.baseline
detect-secrets -v audit --report --fail-on-unaudited --fail-on-live --fail-on-audited-real .secrets.baseline

build:
name: build-test (node v${{ matrix.node-version }})
needs: detect-secrets
runs-on: ubuntu-latest
strategy:
matrix:
node-version: ['20', '22', '24']

steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Setup Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v4
with:
node-version: ${{ matrix.node-version }}

- name: Build/Test
run: |
npm ci
npm run build
npm run test-unit-travis
npm run lint

results:
if: ${{ always() }}
runs-on: ubuntu-latest
name: Final Test Results
needs: [build]
steps:
- run: |
result="${{ needs.build.result }}"
if [[ $result == "success" || $result == "skipped" ]]; then
exit 0
else
exit 1
fi


publish-release:
if: "github.ref_name == 'main' && github.event_name != 'pull_request'"
name: semantic-release
needs: build
runs-on: ubuntu-latest

steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
persist-credentials: false

- name: Setup Node
uses: actions/setup-node@v4
with:
node-version: 22

- name: Build
run: |
npm ci
npm run build

- name: Run semantic-release
env:
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
run: npm run semantic-release
2 changes: 1 addition & 1 deletion ibm-key-protect-api/v2.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1042,7 +1042,7 @@ class IbmKeyProtectApiV2 extends BaseService {
params: IbmKeyProtectApiV2.RestoreKeyParams
): Promise<IbmKeyProtectApiV2.Response<NodeJS.ReadableStream>> {
const _params = { ...params };
const _requiredParams = ['id', 'bluemixInstance', 'keyRestoreBody'];
const _requiredParams = ['id', 'bluemixInstance'];
const _validParams = ['id', 'bluemixInstance', 'keyRestoreBody', 'correlationId', 'xKmsKeyRing', 'prefer', 'headers'];
const _validationErrors = validateParams(_params, _requiredParams, _validParams);
if (_validationErrors) {
Expand Down
Loading
Loading