From 4647cf266e307d747a29283f908c0d7a0565ecef Mon Sep 17 00:00:00 2001 From: Zelin Hao Date: Wed, 13 Dec 2023 16:47:18 -0800 Subject: [PATCH] Update Signed-off-by: Zelin Hao --- ONBOARDING.md | 23 +++++++------------ .../results/release_notes-1.3.14.md | 10 ++++++++ .../results/release_notes_table-1.3.14.md | 12 ++++++++++ .../results/release_notes_urls-1.3.14.txt | 1 + 4 files changed, 31 insertions(+), 15 deletions(-) create mode 100644 src/release_notes_workflow/results/release_notes-1.3.14.md create mode 100644 src/release_notes_workflow/results/release_notes_table-1.3.14.md create mode 100644 src/release_notes_workflow/results/release_notes_urls-1.3.14.txt diff --git a/ONBOARDING.md b/ONBOARDING.md index c227a952d3..76832d863a 100644 --- a/ONBOARDING.md +++ b/ONBOARDING.md @@ -84,18 +84,13 @@ For example, this [PublishToNpm test](https://github.com/opensearch-project/open ## Onboard to PyPi GitHub Action release -Since PyPi has announced the removal of the PGP signature [here](https://blog.pypi.org/posts/2023-05-23-removing-pgp/), it is no longer necessary to run our Jenkins workflow from Universal build as it was mainly focusing on signing. +Since PyPi has [announced](https://blog.pypi.org/posts/2023-05-23-removing-pgp/) the removal of the PGP signature, it is no longer necessary to use the Jenkins environment for releasing artifacts on PyPi. The main motive behind using Jenkins as the release environment was the ease of use of OpenSearch signing system. -With PyPi supporting [OpenID Connect (OIDC)](https://docs.pypi.org/trusted-publishers/adding-a-publisher/) authentication and the addition of trusted publisher on GitHub, the entire release publishing workflow can be executed on GitHub. +With PyPi supporting [OpenID Connect (OIDC)](https://docs.pypi.org/trusted-publishers/adding-a-publisher/) authentication and the addition of trusted publisher on GitHub, the entire release publishing workflow can be executed via GitHub Actions. -Essential part of publishing to PyPi is: +Essential part of publishing to PyPi is using GitHub Action [pypa/gh-action-pypi-publish](https://github.com/marketplace/actions/pypi-publish) for release. It has built-in support for trusted publishing. - - name: Publish package distributions to PyPI - uses: pypa/gh-action-pypi-publish@release/v1 - -which uses action [pypa/gh-action-pypi-publish](https://github.com/marketplace/actions/pypi-publish) for release. It has built-in support for trusted publishing. - -Requirement for this publish action is enabling the permission to get id-token within the stage. +Below permissions are required by the GitHub Action at the job-level: permissions: id-token: write @@ -106,10 +101,10 @@ Sample workflow can be found [here](https://github.com/opensearch-project/opense For any of new repo to onboard GHA workflow release, there are two parts: -1. Create the GitHub workflow e.g. `release-drafter.yml` inside the repo. +1. Create the GitHub workflow e.g. `release.yml` inside the repo. * Allow the GHA triggered by tag creation. * Set up the respective python version and python build stage. - * Enable permissions for these actions. + * Enable permissions for these actions at job-level. * ``` permissions: id-token: write @@ -118,8 +113,6 @@ For any of new repo to onboard GHA workflow release, there are two parts: * `id-token: write` is required for publishing with `pypa/gh-action-pypi-publish`. * `contents: write` is needed for publishing GitHub official release with `softprops/action-gh-release@v1`. * Publish to PyPi with `pypa/gh-action-pypi-publish`. There is an option to publish to Test PyPi. More information can be found [here](https://github.com/marketplace/actions/pypi-publish). - * Generate GitHub release with `softprops/action-gh-release@v1`. - -2. Create an issue with our team to help set up trusted publisher in PyPi. - + * Generate GitHub release with `softprops/action-gh-release`. +2. Create an issue with in opensearch-build repository using [onboarding template](https://github.com/opensearch-project/opensearch-build/issues/new?assignees=&labels=release%2Cuntriaged&projects=&template=standalone_releases_template.yaml&title=%5Brelease%5D%3A+) to help set up trusted publisher in PyPi. diff --git a/src/release_notes_workflow/results/release_notes-1.3.14.md b/src/release_notes_workflow/results/release_notes-1.3.14.md new file mode 100644 index 0000000000..e8f7425754 --- /dev/null +++ b/src/release_notes_workflow/results/release_notes-1.3.14.md @@ -0,0 +1,10 @@ +

OpenSearch and OpenSearch Dashboards 1.3.14 Release Notes

+

MAINTENANCE

+ +

Opensearch Security Dashboards Plugin

+ + + diff --git a/src/release_notes_workflow/results/release_notes_table-1.3.14.md b/src/release_notes_workflow/results/release_notes_table-1.3.14.md new file mode 100644 index 0000000000..4c9d4b7099 --- /dev/null +++ b/src/release_notes_workflow/results/release_notes_table-1.3.14.md @@ -0,0 +1,12 @@ +# OpenSearch Dashboards CommitID(after 2023-09-21) & Release Notes info +| Repo | Branch |CommitID|Commit Date|Release Notes Exists| URL | +|--------------------------|------------------------------------------|--------|-----------|--------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +|alertingDashboards |[7937896ee07160cb4e1fffec989ff64c60c64fa6]| 7937896|2023-11-30 |False | | +|anomalyDetectionDashboards|[4cb5ec5e3d3b234036b1fff1be65186293aefba7]|4cb5ec5 |2023-11-30 |False | | +|functionalTestDashboards |[9fc625b491f39e1682d9fb67ebd862537b103969]|9fc625b |2023-12-01 |False | | +|ganttChartDashboards |[99b9779c0c167d41a53add2c1681ac9968c389c2]|99b9779 |2023-11-30 |False | | +|indexManagementDashboards |[762c086503368b5aa26b3c3e7fe9413aaaaec77f]|762c086 |2023-11-30 |False | | +|observabilityDashboards |[ba3458981e3f2f08950a774a3e2f27e2cdd04885]|ba34589 |2023-11-30 |False | | +|queryWorkbenchDashboards |[95231a70357834240b3169491a8ce35c36fff0cf]|95231a7 |2023-11-30 |False | | +|reportsDashboards |[fb6e305fff5893c8820cad97a353465dcfc1edc6]|fb6e305 |2023-11-30 |False | | +|securityDashboards |[307c7a0674ad1d15fe575a3dbf0a3a7213634099]|307c7a0 |2023-12-08 |True |https://raw.githubusercontent.com/opensearch-project/security-dashboards-plugin/307c7a0674ad1d15fe575a3dbf0a3a7213634099/release-notes/opensearch-security-dashboards-plugin.release-notes-1.3.14.0.md| diff --git a/src/release_notes_workflow/results/release_notes_urls-1.3.14.txt b/src/release_notes_workflow/results/release_notes_urls-1.3.14.txt new file mode 100644 index 0000000000..5a184987e7 --- /dev/null +++ b/src/release_notes_workflow/results/release_notes_urls-1.3.14.txt @@ -0,0 +1 @@ +https://raw.githubusercontent.com/opensearch-project/security-dashboards-plugin/307c7a0674ad1d15fe575a3dbf0a3a7213634099/release-notes/opensearch-security-dashboards-plugin.release-notes-1.3.14.0.md \ No newline at end of file