Merge 1.0.1 to main#5
Conversation
* Merge 1.0.0 to main (#3) * feat: release 1.1.1 * Implemented enrollment, added helper methods and API response handlers * implemented cert retrieval methods on client. * added additional logging, implemented revoke on client * implemented sync and revoke; completed initial functionality * added changelog and license headers * added manifest, disabled auth cert domain check for nexus auth cert * Updated enrollment to include first available procname for enrollment (error when there is no default set). * updated request format for revocation * cleanup * documentation updates * updated project settings for github build * added keyfactor-bootstrap-workflow.yml * updated manifest * added docsource folder * corrected the returned value on a revoke request * Update nexus-certificate-manager-caplugin/NexusCertManagerCAPlugin.cs flattening exception to retain potential useful info Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update docsource/configuration.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update nexus-certificate-manager-caplugin/NexusCertManagerClient.cs Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update nexus-certificate-manager-caplugin/models/Helpers.cs Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update nexus-certificate-manager-caplugin/NexusCertManagerCAPlugin.cs Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update nexus-certificate-manager-caplugin/NexusCertManagerClient.cs Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update nexus-certificate-manager-caplugin/NexusCertManagerCAPlugin.cs Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update nexus-certificate-manager-caplugin/NexusCertManagerClient.cs Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update nexus-certificate-manager-caplugin/NexusCertManagerCAPlugin.cs Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * added check for partial sync * Update nexus-certificate-manager-caplugin/NexusCertManagerCAPlugin.cs Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * updating manifest for doctool build --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Revert "feat: release 1.1.1" (#2) This reverts commit 7388276. --------- Co-authored-by: Joe VanWanzeele <76071503+joevanwanzeeleKF@users.noreply.github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update keyfactor-bootstrap-workflow.yml * Update keyfactor-bootstrap-workflow.yml * chore(ci): add missing inputs to v4 actions * Update generated docs * chore(docs): Minor doc fixes. * Update generated docs --------- Co-authored-by: Morgan Gangwere <470584+indrora@users.noreply.github.com> Co-authored-by: Joe VanWanzeele <76071503+joevanwanzeeleKF@users.noreply.github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Morgan Gangwere <morgan.gangwere@keyfactor.com> Co-authored-by: Keyfactor <keyfactor@keyfactor.github.io>
There was a problem hiding this comment.
Pull request overview
This PR merges the release-1.0 branch into main, bringing in documentation, manifest, and CI/CD updates associated with the 1.0.x release of the Nexus Certificate Manager AnyCA REST Gateway Plugin.
Changes:
- Updated
integration-manifest.jsonwith reformatted JSON structure and simplified field descriptions - Added a new
README.mdwith installation/configuration instructions and updateddocsource/configuration.md - Upgraded the GitHub Actions bootstrap workflow from
v3tov4with new input/secret parameters
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
integration-manifest.json |
Reformatted JSON indentation and shortened ca_plugin_config field descriptions |
docsource/configuration.md |
Revised overview, gateway registration, and CA connection sections for clarity |
README.md |
New full README with support, requirements, installation, and configuration sections |
CHANGELOG.md |
Converted ### heading to ## and capitalized "Initial release" |
.github/workflows/keyfactor-bootstrap-workflow.yml |
Bumped reusable workflow to v4, added with vars for Command integration, and added new secrets |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ## 1.0.0 | ||
| * Initial release No newline at end of file |
There was a problem hiding this comment.
The PR title and description indicate this is a merge of release "1.0.1" to main, but the CHANGELOG.md only has an entry for version 1.0.0 with no new entry added for 1.0.1. If this is indeed a 1.0.1 release, a corresponding changelog entry should be added documenting what changed between 1.0.0 and 1.0.1.
| @@ -0,0 +1,111 @@ | |||
| <h1 align="center" style="border-bottom: none"> | |||
| Nexus Certificate Manager Gateway AnyCA Gateway REST Plugin | |||
There was a problem hiding this comment.
The H1 heading on line 2 and the product name used in lines 44, 61, 62, 72, and 76 all contain extra spaces in "Nexus Certificate Manager Gateway AnyCA Gateway REST Plugin" (three spaces between "Manager" and "Gateway"). The product name should likely be "Nexus Certificate Manager AnyCA Gateway REST Plugin" or similar, without the extra spaces. This appears to be a copy-paste artifact.
| The Nexus Certificate Manager Gateway AnyCA Gateway REST plugin is compatible with the Keyfactor AnyCA Gateway REST 25.2.0 and later. | ||
|
|
||
| ## Support | ||
| The Nexus Certificate Manager Gateway AnyCA Gateway REST plugin is open source and there is **no SLA**. Keyfactor will address issues as resources become available. Keyfactor customers may request escalation by opening up a support ticket through their Keyfactor representative. | ||
|
|
||
| > To report a problem or suggest a new feature, use the **[Issues](../../issues)** tab. If you want to contribute actual bug fixes or proposed enhancements, use the **[Pull requests](../../pulls)** tab. | ||
|
|
||
| ## Requirements | ||
|
|
||
| - The host URL for the instance of Nexus Certificate Manager | ||
| - A certificate in the pfx format to use for authentication into Nexus Certificate Manager, located on the Gateway Host | ||
| - The passphrase for the pfx certificate | ||
|
|
||
| ## Installation | ||
|
|
||
| 1. Install the AnyCA Gateway REST per the [official Keyfactor documentation](https://software.keyfactor.com/Guides/AnyCAGatewayREST/Content/AnyCAGatewayREST/InstallIntroduction.htm). | ||
|
|
||
| 2. On the server hosting the AnyCA Gateway REST, download and unzip the latest [Nexus Certificate Manager Gateway AnyCA Gateway REST plugin](https://github.com/Keyfactor/nexus-certificate-manager-caplugin/releases/latest) from GitHub. | ||
|
|
||
| 3. Copy the unzipped directory (usually called `net6.0` or `net8.0`) to the Extensions directory: | ||
|
|
||
|
|
||
| ```shell | ||
| Depending on your AnyCA Gateway REST version, copy the unzipped directory to one of the following locations: | ||
| Program Files\Keyfactor\AnyCA Gateway\AnyGatewayREST\net6.0\Extensions | ||
| Program Files\Keyfactor\AnyCA Gateway\AnyGatewayREST\net8.0\Extensions | ||
| ``` | ||
|
|
||
| > The directory containing the Nexus Certificate Manager Gateway AnyCA Gateway REST plugin DLLs (`net6.0` or `net8.0`) can be named anything, as long as it is unique within the `Extensions` directory. | ||
|
|
||
| 4. Restart the AnyCA Gateway REST service. | ||
|
|
||
| 5. Navigate to the AnyCA Gateway REST portal and verify that the Gateway recognizes the Nexus Certificate Manager Gateway plugin by hovering over the ⓘ symbol to the right of the Gateway on the top left of the portal. |
There was a problem hiding this comment.
Lines 44, 61, 62, 72, and 76 also contain the same extra-space product name "Nexus Certificate Manager Gateway AnyCA Gateway REST Plugin". These occurrences should be corrected consistently throughout the file.
| ```shell | ||
| Depending on your AnyCA Gateway REST version, copy the unzipped directory to one of the following locations: | ||
| Program Files\Keyfactor\AnyCA Gateway\AnyGatewayREST\net6.0\Extensions | ||
| Program Files\Keyfactor\AnyCA Gateway\AnyGatewayREST\net8.0\Extensions | ||
| ``` |
There was a problem hiding this comment.
The shell code block (lines 66–70) contains plain English prose rather than actual shell commands. A code block tagged as shell is expected to contain executable commands, not instructional text. The prose describing where to copy files should be moved outside the code block, or the code block should contain actual shell commands (e.g., copy or xcopy commands for Windows).
| ## CA Connection | ||
|
|
||
| The certificate used by the gateway to authenticate into Nexus Certificate Manager must be copied to a location on the Gateway Host accessible by the gateway service. | ||
|
|
||
|
|
There was a problem hiding this comment.
The README has a duplicate "CA Connection" section. The information about authenticating into Nexus Certificate Manager is already described in step 1 of the Configuration section (lines 86–88) and then repeated again as a standalone top-level section at lines 100–102. The standalone "## CA Connection" section (lines 100–102) appears to be redundant and should be removed to avoid confusing readers.
| ## CA Connection | |
| The certificate used by the gateway to authenticate into Nexus Certificate Manager must be copied to a location on the Gateway Host accessible by the gateway service. |
Merge release-1.0 to main - Automated PR