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

Cleanup #1986

Closed
wants to merge 16 commits into from
Closed

Cleanup #1986

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
3 changes: 1 addition & 2 deletions .github/workflows/auto-comment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,8 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3

- name: Process Label Action
uses: hramos/respond-to-issue-based-on-label@v2
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
configuration-path: '.github/label-actions.yml'
configuration-path: '.github/label-actions.yml'
26 changes: 26 additions & 0 deletions .github/workflows/sync-cli-readmes.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# name: Sync Files on README.md Changes

# on:
# push:
# paths:
# - '**/README.md'

# jobs:
# sync-files:
# runs-on: ubuntu-latest

# steps:
# - name: Checkout repository
# uses: actions/checkout@v2

# - name: Sync files
# run: |
# cp "${{ github.workspace }}/README.md" "${{ github.workspace }}/packages/cli/README.md"

# - name: Commit then Push Changes
# run: |
# git config --global user.name ${{ secrets.ZOWE_ROBOT_USER }}
# git config --global user.email ${{ secrets.ZOWE_ROBOT_EMAIL }}
# git add "${{ github.workspace }}/packages/cli/README.md"
# git commit -sm "Synching cli readmes"
# git push origin HEAD
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
[![codecov](https://codecov.io/gh/zowe/zowe-cli/branch/master/graph/badge.svg)](https://codecov.io/gh/zowe/zowe-cli)
[![OpenSSF Best Practices](https://bestpractices.coreinfrastructure.org/projects/7204/badge)](https://bestpractices.coreinfrastructure.org/projects/7204)

>[!IMPORTANT] testing

Zowe CLI is a command-line interface that lets you interact with the mainframe in a familiar format. Zowe CLI helps to increase overall productivity, reduce the learning curve for developing mainframe applications, and exploit the ease-of-use of off-platform tools. Zowe CLI lets you use common tools such as Integrated Development Environments (IDEs), shell commands, bash scripts, and build tools for mainframe development. Through its ecosystem of plug-ins, you can automate actions on systems such as IBM Db2, IBM CICS, and more. It provides a set of utilities and services that help developers, DevOps engineers, and more become efficient in supporting and building z/OS applications quickly.

This repository also contains the Zowe Node Client SDK. The SDK lets you leverage the underlying APIs to build applications that interface with the mainframe.
Expand Down Expand Up @@ -44,7 +46,7 @@ Guidelines for contributing to Zowe SDKs| [SDK Guidelines](./docs/SDKGuidelines.
Versioning conventions for Zowe CLI and Plug-ins| [Versioning Guidelines](./docs/MaintainerVersioning.md) |
| Miscellaneous tips for development | [Development Tips](./docs/DevelopmentTips.md)

**Tip:**
**Tip:**
- Visit our [Sample Plug-in repository](https://github.com/zowe/zowe-cli-sample-plugin) for example plug-in code. You can follow developer tutorials [here](https://docs.zowe.org/stable/extend/extend-cli/cli-devTutorials.html).

<br/>
Expand All @@ -70,7 +72,7 @@ When you update `package.json` to include new dependencies, or when you pull cha
npm update
```

**Tip:**
**Tip:**
- When necessary, you can run the install command again to update dependencies changed in `package.json`.

<br/>
Expand All @@ -82,7 +84,7 @@ From your copy of this repository, after a build, navigate to the `packages/cli`
npm install -g
```

**Notes:**
**Notes:**
- Depending on how you configured npm on Linux or Mac, you might need to prefix the `npm install -g` command or the `npm uninstall -g` command with `sudo` to let npm have write access to the installation directory.
- On Windows, the `npm install -g` command might fail several times due to an `EPERM` error. This appears to be a bug that npm documented in their GitHub issues. This behaviour does not appear to be specific to installing the Zowe CLI package. Unfortunately, the only solution that we know of is to issue the `npm cache clean` command and the `npm install -g` command repeatedly until it works.

Expand Down Expand Up @@ -115,7 +117,7 @@ zowe zosmf check status

For detailed information about creating service profiles, creating base profiles, or integrating with Zowe API ML, see [Using Zowe CLI](https://docs.zowe.org/stable/user-guide/cli-using-usingcli/).

**Tip:**
**Tip:**
- When you confirm that your profile connects to and communicates with your mainframe system successfully, you can issue the same command at any time to verify the availability and status of the z/OSMF subsystem on your mainframe.

<br/>
Expand All @@ -126,7 +128,7 @@ The Zowe Node Client SDK consists of APIs that enable you to build client applic

For information about downloading and getting started with the SDK, see the [Zowe Docs](https://docs.zowe.org/stable/user-guide/sdks-using). To view the Zowe Node.js SDK doc, see [Zowe SDK Docs](https://docs.zowe.org/stable/typedoc/index.html).

**Tip:**
**Tip:**
- Alternatively, you can import Zowe CLI into your project to call the Node APIs. However, importing all of Zowe CLI will increase the size of your project. For example, use the following statement to import packages from Zowe CLI:

```
Expand Down Expand Up @@ -197,7 +199,7 @@ npm run test:system
- V2 uses **team profiles** and **deprecates the Secure Credential Store** (SCS) plug-in.

Connection details can be managed efficiently within one file, promoting a global configuration that can be shared across teams and mainframe services. For more information on how to use profiles, visit [Zowe Docs](https://docs.zowe.org/stable/user-guide/cli-using-using-team-profiles/).

Secure credential encryption is included in the core CLI.

<br/>
Expand Down
55 changes: 0 additions & 55 deletions autocompletion/README.md

This file was deleted.

66 changes: 0 additions & 66 deletions autocompletion/zowe.bash

This file was deleted.

31 changes: 20 additions & 11 deletions packages/cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
[![codecov](https://codecov.io/gh/zowe/zowe-cli/branch/master/graph/badge.svg)](https://codecov.io/gh/zowe/zowe-cli)
[![OpenSSF Best Practices](https://bestpractices.coreinfrastructure.org/projects/7204/badge)](https://bestpractices.coreinfrastructure.org/projects/7204)

>[!IMPORTANT] testing

Zowe CLI is a command-line interface that lets you interact with the mainframe in a familiar format. Zowe CLI helps to increase overall productivity, reduce the learning curve for developing mainframe applications, and exploit the ease-of-use of off-platform tools. Zowe CLI lets you use common tools such as Integrated Development Environments (IDEs), shell commands, bash scripts, and build tools for mainframe development. Through its ecosystem of plug-ins, you can automate actions on systems such as IBM Db2, IBM CICS, and more. It provides a set of utilities and services that help developers, DevOps engineers, and more become efficient in supporting and building z/OS applications quickly.

This repository also contains the Zowe Node Client SDK. The SDK lets you leverage the underlying APIs to build applications that interface with the mainframe.
Expand All @@ -11,13 +13,14 @@ This repository also contains the Zowe Node Client SDK. The SDK lets you leverag
## **Contents** <!-- omit in toc -->
- [Documentation](#documentation)
- [Contribution Guidelines](#contribution-guidelines)
- [Building Zowe CLI From Source](#build-zowe-cli-from-source)
- [Installing Zowe CLI From Source](#install-zowe-cli-from-source)
- [Uninstalling Zowe CLI](#uninstall-zowe-cli)
- [Configuring Zowe CLI](#configure-zowe-cli)
- [Building Zowe CLI From Source](#building-zowe-cli-from-source)
- [Installing Zowe CLI From Source](#installing-zowe-cli-from-source)
- [Uninstalling Zowe CLI](#uninstalling-zowe-cli)
- [Configuring Zowe CLI](#configuring-zowe-cli)
- [Zowe Node Client SDK](#zowe-node-client-sdk)
- [Running System Tests](#run-system-tests)
- [Running System Tests](#running-system-tests)
- [FAQs](#frequently-asked-questions)
- [Project Structure and Governance](#project-structure-and-governance)

<br/>

Expand All @@ -43,7 +46,7 @@ Guidelines for contributing to Zowe SDKs| [SDK Guidelines](./docs/SDKGuidelines.
Versioning conventions for Zowe CLI and Plug-ins| [Versioning Guidelines](./docs/MaintainerVersioning.md) |
| Miscellaneous tips for development | [Development Tips](./docs/DevelopmentTips.md)

**Tip:**
**Tip:**
- Visit our [Sample Plug-in repository](https://github.com/zowe/zowe-cli-sample-plugin) for example plug-in code. You can follow developer tutorials [here](https://docs.zowe.org/stable/extend/extend-cli/cli-devTutorials.html).

<br/>
Expand All @@ -69,7 +72,7 @@ When you update `package.json` to include new dependencies, or when you pull cha
npm update
```

**Tip:**
**Tip:**
- When necessary, you can run the install command again to update dependencies changed in `package.json`.

<br/>
Expand All @@ -81,7 +84,7 @@ From your copy of this repository, after a build, navigate to the `packages/cli`
npm install -g
```

**Notes:**
**Notes:**
- Depending on how you configured npm on Linux or Mac, you might need to prefix the `npm install -g` command or the `npm uninstall -g` command with `sudo` to let npm have write access to the installation directory.
- On Windows, the `npm install -g` command might fail several times due to an `EPERM` error. This appears to be a bug that npm documented in their GitHub issues. This behaviour does not appear to be specific to installing the Zowe CLI package. Unfortunately, the only solution that we know of is to issue the `npm cache clean` command and the `npm install -g` command repeatedly until it works.

Expand Down Expand Up @@ -114,7 +117,7 @@ zowe zosmf check status

For detailed information about creating service profiles, creating base profiles, or integrating with Zowe API ML, see [Using Zowe CLI](https://docs.zowe.org/stable/user-guide/cli-using-usingcli/).

**Tip:**
**Tip:**
- When you confirm that your profile connects to and communicates with your mainframe system successfully, you can issue the same command at any time to verify the availability and status of the z/OSMF subsystem on your mainframe.

<br/>
Expand All @@ -125,7 +128,7 @@ The Zowe Node Client SDK consists of APIs that enable you to build client applic

For information about downloading and getting started with the SDK, see the [Zowe Docs](https://docs.zowe.org/stable/user-guide/sdks-using). To view the Zowe Node.js SDK doc, see [Zowe SDK Docs](https://docs.zowe.org/stable/typedoc/index.html).

**Tip:**
**Tip:**
- Alternatively, you can import Zowe CLI into your project to call the Node APIs. However, importing all of Zowe CLI will increase the size of your project. For example, use the following statement to import packages from Zowe CLI:

```
Expand Down Expand Up @@ -196,9 +199,15 @@ npm run test:system
- V2 uses **team profiles** and **deprecates the Secure Credential Store** (SCS) plug-in.

Connection details can be managed efficiently within one file, promoting a global configuration that can be shared across teams and mainframe services. For more information on how to use profiles, visit [Zowe Docs](https://docs.zowe.org/stable/user-guide/cli-using-using-team-profiles/).

Secure credential encryption is included in the core CLI.

<br/>

Don't see what you're looking for? Browse questions from the community or ask your own in the [Q&A section](https://github.com/zowe/zowe-cli/discussions/categories/q-a) of our repo.

## **Project Structure and Governance**

Zowe CLI is a component of the Zowe Open Mainframe Project, part of the Linux Foundation.

To learn more about how Zowe is structured and governed, see the [Technical Steering Committee Structure and Governance documentation](https://github.com/zowe/community/blob/master/Technical-Steering-Committee/tsc-governance.md).
3 changes: 2 additions & 1 deletion packages/core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@

The Zowe SDK Core package contains functionality that is shared across all other SDK packages, such as `@zowe/zos-files-for-zowe-sdk`.

**Important!** You must install the Core package to satisfy the peer dependency requirement for all other SDK packages.
> [!IMPORTANT]
> You must install the Core package to satisfy the peer dependency requirement for all other SDK packages.

## Core libraries

Expand Down
Loading
Loading