Skip to content

Commit

Permalink
Update
Browse files Browse the repository at this point in the history 
Signed-off-by: Zelin Hao <[email protected]>
  • Loading branch information
@zelinh
zelinh committed Dec 14, 2023
1 parent 3f85f42 commit 4647cf2
Show file tree
Hide file tree
Showing 4 changed files with 31 additions and 15 deletions.
23 changes: 8 additions & 15 deletions ONBOARDING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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.
10 changes: 10 additions & 0 deletions src/release_notes_workflow/results/release_notes-1.3.14.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<h1>OpenSearch and OpenSearch Dashboards 1.3.14 Release Notes</h1>
<h2>MAINTENANCE</h2>

<h3>Opensearch Security Dashboards Plugin</h3>

<ul>
<li>Update <code>yarn.lock</code> file (<a href="https://github.com/opensearch-project/security-dashboards-plugin/pull/1669">#1669</a>)</li>
<li>Bump <code>debug</code> to <code>4.3.4</code> and <code>browserify-sign</code> to <code>4.2.2</code> to address CVEs (<a href="https://github.com/opensearch-project/security-dashboards-plugin/pull/1674">#1674</a>)</li>
</ul>

12 changes: 12 additions & 0 deletions src/release_notes_workflow/results/release_notes_table-1.3.14.md
View file
Original file line number Diff line number Diff line change
@@ -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|
1 change: 1 addition & 0 deletions src/release_notes_workflow/results/release_notes_urls-1.3.14.txt
View file
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 4647cf2

Please sign in to comment.