Skip to content

Commit

Permalink
Merge pull request #2780 from zowe/rename-repo-and-test-provenance
Browse files Browse the repository at this point in the history
Update repo name in GitHub links and enable provenance for ZE API package
  • Loading branch information
zFernand0 authored Mar 13, 2024
2 parents c325db4 + cf4c569 commit 560c2de
Show file tree
Hide file tree
Showing 21 changed files with 56 additions and 50 deletions.
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ labels: bug, new
---

<!--
Before opening a new issue, please search our existing issues: https://github.com/zowe/vscode-extension-for-zowe/issues
Before opening a new issue, please search our existing issues: https://github.com/zowe/zowe-explorer-vscode/issues
-->

**Describe the bug**
Expand Down Expand Up @@ -36,7 +36,7 @@ Steps to reproduce the behavior:
- Zowe Explorer Version:
- (Optional) Zowe CLI Version:
- (Optional) Are you using Secure Credential Store?
<!-- If you have SCS installed, please read the documentation for Integrating SCS within Zowe Explorer: https://github.com/zowe/vscode-extension-for-zowe/blob/main/docs/README-Security.md -->
<!-- If you have SCS installed, please read the documentation for Integrating SCS within Zowe Explorer: https://github.com/zowe/zowe-explorer-vscode/blob/main/docs/README-Security.md -->

**Additional context**

Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Question
url: https://github.com/zowe/vscode-extension-for-zowe/discussions/new?category=q-a
url: https://github.com/zowe/zowe-explorer-vscode/discussions/new?category=q-a
about: Please ask and answer questions here.
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ _Put an `x` in the boxes that apply_

_Put an `x` in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This checklist will be used as reference for both the contributor and the reviewer_

- [ ] I have read the [CONTRIBUTOR GUIDANCE](https://github.com/zowe/vscode-extension-for-zowe/wiki/Best-Practices:-Contributor-Guidance) wiki
- [ ] I have read the [CONTRIBUTOR GUIDANCE](https://github.com/zowe/zowe-explorer-vscode/wiki/Best-Practices:-Contributor-Guidance) wiki
- [ ] PR title follows [Conventional Commits Guidelines](https://www.conventionalcommits.org/en/v1.0.0-beta.2/)
- [ ] PR Description is included
- [ ] gif or screenshot is included if visual changes are made
Expand Down
3 changes: 3 additions & 0 deletions .github/workflows/deployment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ jobs:
release:
if: github.event_name == 'workflow_dispatch' || github.ref_protected
runs-on: ubuntu-latest
permissions:
contents: read
id-token: write

steps:
- name: Checkout
Expand Down
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[![version](https://img.shields.io/visual-studio-marketplace/v/Zowe.vscode-extension-for-zowe.svg)](https://img.shields.io/visual-studio-marketplace/v/Zowe.vscode-extension-for-zowe.svg)
[![downloads](https://img.shields.io/visual-studio-marketplace/d/Zowe.vscode-extension-for-zowe.svg)](https://img.shields.io/visual-studio-marketplace/d/Zowe.vscode-extension-for-zowe.svg)
[![codecov](https://codecov.io/gh/zowe/vscode-extension-for-zowe/branch/main/graph/badge.svg)](https://codecov.io/gh/zowe/vscode-extension-for-zowe)
[![codecov](https://codecov.io/gh/zowe/zowe-explorer-vscode/branch/main/graph/badge.svg)](https://codecov.io/gh/zowe/zowe-explorer-vscode)
[![slack](https://img.shields.io/badge/chat-on%20Slack-blue)](https://slack.openmainframeproject.org/)

Welcome to Zowe Explorer! Zowe Explorer brings mainframe capabilities to modern IDEs, such as VS Code. [Zowe](https://www.zowe.org/) is a project hosted by the [Open Mainframe Project](https://www.openmainframeproject.org/), a [Linux Foundation](https://www.linuxfoundation.org/) project.
Expand Down Expand Up @@ -39,7 +39,7 @@ Clone the repository, build a VSIX file, and start working with the extension.
1. Clone the repository by issuing the following command in your local command-line interface:

```shell
git clone https://github.com/zowe/vscode-extension-for-zowe.git
git clone https://github.com/zowe/zowe-explorer-vscode.git
```

2. Change directories into the newly-cloned repository:
Expand All @@ -64,39 +64,39 @@ Now install the extension to VS Code.

You can now use the extension.

For more information on how to run tests for the extension, see [Developer Setup](https://github.com/zowe/vscode-extension-for-zowe/wiki/Developer-Setup).
For more information on how to run tests for the extension, see [Developer Setup](https://github.com/zowe/zowe-explorer-vscode/wiki/Developer-Setup).

## Available Documentation

The current repository of the VS Code extension Zowe Explorer includes several ReadMes that highlight different aspects of using the extension.

Use the following list with the description and links to find the topics of your interest:

[Core Zowe Explorer ReadMe](https://github.com/zowe/vscode-extension-for-zowe/blob/main/packages/zowe-explorer/README.md) — contains information about how to install, configure, and use Zowe Explorer. This ReadMe helps you to familiarize yourself with the basic features of the extension.
[Core Zowe Explorer ReadMe](https://github.com/zowe/zowe-explorer-vscode/blob/main/packages/zowe-explorer/README.md) — contains information about how to install, configure, and use Zowe Explorer. This ReadMe helps you to familiarize yourself with the basic features of the extension.

[Zowe Explorer ESlint Plug-in ReadMe](https://github.com/zowe/vscode-extension-for-zowe/blob/main/packages/eslint-plugin-zowe-explorer/README.md) — contains information about how to install ESLint and configure ESLint rules. ESLint helps you to find and fix problems in your JavaScript code.
[Zowe Explorer ESlint Plug-in ReadMe](https://github.com/zowe/zowe-explorer-vscode/blob/main/packages/eslint-plugin-zowe-explorer/README.md) — contains information about how to install ESLint and configure ESLint rules. ESLint helps you to find and fix problems in your JavaScript code.

[Zowe Explorer Extensibility API ReadMe](https://github.com/zowe/vscode-extension-for-zowe/blob/main/packages/zowe-explorer-api/README.md) — contains information about how to extend the capabilities of Zowe Explorer, using the extensibility API.
[Zowe Explorer Extensibility API ReadMe](https://github.com/zowe/zowe-explorer-vscode/blob/main/packages/zowe-explorer-api/README.md) — contains information about how to extend the capabilities of Zowe Explorer, using the extensibility API.

[Zowe Explorer FTP Extension ReadMe](https://github.com/zowe/vscode-extension-for-zowe/blob/main/packages/zowe-explorer-ftp-extension/README.md) — contains information about how to install and use the Zowe Explorer extension for FTP. The extension adds the FTP protocol to Zowe Explorer, enabling you to use z/OS FTP Plug-in for Zowe CLI profiles to connect and interact with z/OS USS and MVS.
[Zowe Explorer FTP Extension ReadMe](https://github.com/zowe/zowe-explorer-vscode/blob/main/packages/zowe-explorer-ftp-extension/README.md) — contains information about how to install and use the Zowe Explorer extension for FTP. The extension adds the FTP protocol to Zowe Explorer, enabling you to use z/OS FTP Plug-in for Zowe CLI profiles to connect and interact with z/OS USS and MVS.

**Note**: Zowe Explorer FTP extension is an example that shows how the extensibility API is used to add new capabilities to Zowe Explorer.

[Zowe Explorer Developer Setup](https://github.com/zowe/vscode-extension-for-zowe/wiki/Developer-Setup) — contains information on how to install, build, and test Zowe Explorer.
[Zowe Explorer Developer Setup](https://github.com/zowe/zowe-explorer-vscode/wiki/Developer-Setup) — contains information on how to install, build, and test Zowe Explorer.

[Zowe Explorer Developing for Theia](https://github.com/zowe/vscode-extension-for-zowe/wiki/Developing-for-Theia) — contains information on how to develop for the Web-based IDE Eclipse Theia.
[Zowe Explorer Developing for Theia](https://github.com/zowe/zowe-explorer-vscode/wiki/Developing-for-Theia) — contains information on how to develop for the Web-based IDE Eclipse Theia.

## How to Contribute

We encourage you to contribute to Zowe Explorer!

Check the current [open issues](https://github.com/zowe/vscode-extension-for-zowe/issues) to choose where you can contribute. You can look for the `help wanted`-labeled issues to find issues that require additional input. If you are new to the project, you might want to check the issues with the `good first issue` label.
Check the current [open issues](https://github.com/zowe/zowe-explorer-vscode/issues) to choose where you can contribute. You can look for the `help wanted`-labeled issues to find issues that require additional input. If you are new to the project, you might want to check the issues with the `good first issue` label.

To report a bug or request a specific feature, please open a GitHub issue using the [appropriate template](https://github.com/zowe/vscode-extension-for-zowe/issues/new/choose). Feature requests will be added to our backlog after it receives 10 upvotes from the community.
To report a bug or request a specific feature, please open a GitHub issue using the [appropriate template](https://github.com/zowe/zowe-explorer-vscode/issues/new/choose). Feature requests will be added to our backlog after it receives 10 upvotes from the community.

Also, you can check our [Zenhub Communities boards](https://github.com/zowe/vscode-extension-for-zowe#workspaces/zowe-cli-explorers-5d77ca38fb288f0001ceae92/board?repos=150100207) for a more convenient view of issues and access to other boards of Zowe-related projects.
Also, you can check our [Zenhub Communities boards](https://github.com/zowe/zowe-explorer-vscode#workspaces/zowe-cli-explorers-5d77ca38fb288f0001ceae92/board?repos=150100207) for a more convenient view of issues and access to other boards of Zowe-related projects.

For more information on how to contribute, see [Contributor Guidance](https://github.com/zowe/vscode-extension-for-zowe/wiki/Contributor-Guidance).
For more information on how to contribute, see [Contributor Guidance](https://github.com/zowe/zowe-explorer-vscode/wiki/Contributor-Guidance).

## External Links

Expand Down
10 changes: 5 additions & 5 deletions docs/Conformance Criteria/README-Conformance Criteria V2.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ General conformance criteria for all extensions that add new capabilities to Zow
<th style="background-color:#AAAAAA"></th>
<th style="background-color:#AAAAAA">x</th>
<th></th>
<td><b>Error message consistency:</b> Extension follows the recommended error message format indicated in the <a href=https://github.com/zowe/vscode-extension-for-zowe/blob/main/docs/extenders/Error%20Handling.md>Zowe Explorer extensibility documentation</a> to provide a consistent user experience with Zowe Explorer.</td>
<td><b>Error message consistency:</b> Extension follows the recommended error message format indicated in the <a href=https://github.com/zowe/zowe-explorer-vscode/blob/main/docs/extenders/Error%20Handling.md>Zowe Explorer extensibility documentation</a> to provide a consistent user experience with Zowe Explorer.</td>
</tr>

<tr>
Expand Down Expand Up @@ -178,7 +178,7 @@ Criteria for VS Code extensions that want to access the same Zowe CLI profiles t
<th style="background-color:#AAAAAA">x</th>
<th style="background-color:#AAAAAA"></th>
<th></th>
<td><b>Zowe Extender access:</b> Extension accesses the shared Zowe Explorer profiles cache via `ZoweExplorerApi.IApiRegisterClient.getExplorerExtenderApi()` API as documented in the <a href=https://github.com/zowe/vscode-extension-for-zowe/blob/main/docs/README-Extending.md#using-the-zowe-explorer-profilescache-for-an-extenders-own-unrelated-profiles>Zowe Explorer extensibility documentation.</td>
<td><b>Zowe Extender access:</b> Extension accesses the shared Zowe Explorer profiles cache via `ZoweExplorerApi.IApiRegisterClient.getExplorerExtenderApi()` API as documented in the <a href=https://github.com/zowe/zowe-explorer-vscode/blob/main/docs/README-Extending.md#using-the-zowe-explorer-profilescache-for-an-extenders-own-unrelated-profiles>Zowe Explorer extensibility documentation.</td>
</tr>

<tr>
Expand Down Expand Up @@ -246,7 +246,7 @@ Criteria for VS Code extensions that extend the Zowe Explorer MVS, USS, or JES t
<th style="background-color:#AAAAAA">x</th>
<th style="background-color:#AAAAAA"></th>
<th></th>
<td><b>New Zowe CLI profile type:</b> Extension registers its new API instances with a new profile type name for the different Zowe Explorer views via the `ZoweExplorerApi.IApiRegisterClient.register{Mvs|Uss|Jes}Api(profileTypeName)` call as indicated from the <a href=https://github.com/zowe/vscode-extension-for-zowe/blob/main/docs/README-Extending.md#using-the-zowe-explorer-profilescache-for-an-extenders-own-unrelated-profiles>Zowe Explorer extensibility documentation</a></td>
<td><b>New Zowe CLI profile type:</b> Extension registers its new API instances with a new profile type name for the different Zowe Explorer views via the `ZoweExplorerApi.IApiRegisterClient.register{Mvs|Uss|Jes}Api(profileTypeName)` call as indicated from the <a href=https://github.com/zowe/zowe-explorer-vscode/blob/main/docs/README-Extending.md#using-the-zowe-explorer-profilescache-for-an-extenders-own-unrelated-profiles>Zowe Explorer extensibility documentation</a></td>
</tr>

<tr>
Expand Down Expand Up @@ -333,7 +333,7 @@ Criteria for VS Code extensions adding menu and commands to VS Code that utilize
<th style="background-color:#AAAAAA">x</th>
<th style="background-color:#AAAAAA"></th>
<th></th>
<td><b>Context menu groups: </b> If contributing commands to Zowe Explorer's context menus, the extension follows the <a href=https://github.com/zowe/vscode-extension-for-zowe/blob/main/docs/README-Extending.md#grouping-menu-commands>Zowe Explorer extensibility documentation</a> and adds them in new context menu groups that are located below Zowe Explorer's existing context menu groups in the user interface.</td>
<td><b>Context menu groups: </b> If contributing commands to Zowe Explorer's context menus, the extension follows the <a href=https://github.com/zowe/zowe-explorer-vscode/blob/main/docs/README-Extending.md#grouping-menu-commands>Zowe Explorer extensibility documentation</a> and adds them in new context menu groups that are located below Zowe Explorer's existing context menu groups in the user interface.</td>
</tr>

<tr>
Expand All @@ -342,7 +342,7 @@ Criteria for VS Code extensions adding menu and commands to VS Code that utilize
<th style="background-color:#AAAAAA"></th>
<th style="background-color:#AAAAAA">x</th>
<th></th>
<td><b>Adding New Menu Items:</b> If the extension is adding new commands and context menu entries to the Zowe Explorer tree view nodes, the new command name is consistent with the terminology and naming conventions of the existing Zowe Explorer menu entries. More information is provided in the <a href=https://github.com/zowe/vscode-extension-for-zowe/blob/main/docs/README-Extending.md#creating-an-extension-that-adds-menu-commands
<td><b>Adding New Menu Items:</b> If the extension is adding new commands and context menu entries to the Zowe Explorer tree view nodes, the new command name is consistent with the terminology and naming conventions of the existing Zowe Explorer menu entries. More information is provided in the <a href=https://github.com/zowe/zowe-explorer-vscode/blob/main/docs/README-Extending.md#creating-an-extension-that-adds-menu-commands
>Zowe Explorer extensibility documentation.</a></td>
</tr>
Expand Down
2 changes: 1 addition & 1 deletion docs/early-access/v2/Profile-Configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Install vNext.

**Follow these steps**:

1. Download the [vNext-enabled Zowe Explorer version](https://github.com/zowe/vscode-extension-for-zowe/releases) from the Zowe Explorer Github release page.
1. Download the [vNext-enabled Zowe Explorer version](https://github.com/zowe/zowe-explorer-vscode/releases) from the Zowe Explorer Github release page.
2. Open VS Code.
3. Navigate to **File** > **Preferences** > **Extensions** > **Install from vsix\*\***.
4. Select the .vsix file to install.
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"author": "Zowe",
"license": "EPL-2.0",
"repository": {
"url": "https://github.com/zowe/vscode-extension-for-zowe"
"url": "https://github.com/zowe/zowe-explorer-vscode"
},
"private": true,
"workspaces": [
Expand Down
12 changes: 6 additions & 6 deletions packages/zowe-explorer-api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
[![version](https://img.shields.io/npm/v/@zowe/zowe-explorer-api)](https://img.shields.io/npm/v/@zowe/zowe-explorer-api)
[![downloads](https://img.shields.io/npm/dt/@zowe/zowe-explorer-api)](https://img.shields.io/npm/dt/@zowe/zowe-explorer-api)

Extensibility API for Zowe Explorer is a collection of APIs that can be used to extend the [Zowe Explorer](https://github.com/zowe/vscode-extension-for-zowe) VS Code extension with alternative z/OS interaction protocols and new capabilities.
Extensibility API for Zowe Explorer is a collection of APIs that can be used to extend the [Zowe Explorer](https://github.com/zowe/zowe-explorer-vscode) VS Code extension with alternative z/OS interaction protocols and new capabilities.

The current state of this API is experimental, but the goal is provide a stabilized version that can be used for Zowe Conformance certifications in the future. See this issue for more details: <https://github.com/zowe/vscode-extension-for-zowe/issues/837>.
The current state of this API is experimental, but the goal is provide a stabilized version that can be used for Zowe Conformance certifications in the future. See this issue for more details: <https://github.com/zowe/zowe-explorer-vscode/issues/837>.

However, the current API is being used by other extensions already, such as for Zowe Explorer with the [Zowe Explorer FTP Extension](../zowe-explorer-ftp-extension) that you can find in this same Git repository, as well as for commercial extensions maintained by Zowe's contributors and available on their company websites.

Expand Down Expand Up @@ -43,14 +43,14 @@ import * as vscode from "vscode";

imports.

See this [documentation on Extending Zowe Explorer](https://github.com/zowe/vscode-extension-for-zowe/wiki/Extending-Zowe-Explorer) to learn more about the Tree APIs available.
See this [documentation on Extending Zowe Explorer](https://github.com/zowe/zowe-explorer-vscode/wiki/Extending-Zowe-Explorer) to learn more about the Tree APIs available.

## Logger API

See this [special extension document](https://github.com/zowe/vscode-extension-for-zowe/wiki/Error-Handling-for-Extenders#logging-of-error-message) for more information about using the Logger API.
See this [special extension document](https://github.com/zowe/zowe-explorer-vscode/wiki/Error-Handling-for-Extenders#logging-of-error-message) for more information about using the Logger API.

## Providing feedback or help contributing

Extensibility API for Zowe Explorer is part of the [Zowe Explorer monorepo on Github](https://github.com/zowe/vscode-extension-for-zowe). You find the sources there in the `/packages/zowe-explorer-api` sub-folder.
Extensibility API for Zowe Explorer is part of the [Zowe Explorer monorepo on Github](https://github.com/zowe/zowe-explorer-vscode). You find the sources there in the `/packages/zowe-explorer-api` sub-folder.

To file issues, use the [Zowe Explorer issue list](https://github.com/zowe/vscode-extension-for-zowe/issues) after reviewing the [API Roadmap item](https://github.com/zowe/vscode-extension-for-zowe/issues/837).
To file issues, use the [Zowe Explorer issue list](https://github.com/zowe/zowe-explorer-vscode/issues) after reviewing the [API Roadmap item](https://github.com/zowe/zowe-explorer-vscode/issues/837).
5 changes: 4 additions & 1 deletion packages/zowe-explorer-api/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,10 @@
"author": "Zowe",
"license": "EPL-2.0",
"repository": {
"url": "https://github.com/zowe/vscode-extension-for-zowe"
"url": "https://github.com/zowe/zowe-explorer-vscode"
},
"publishConfig": {
"provenance": true
},
"main": "lib/index.js",
"files": [
Expand Down
Loading

0 comments on commit 560c2de

Please sign in to comment.