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

Adjust Readme to new pipeline #119

Merged
merged 10 commits into from
Jul 19, 2024
Merged
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
Binary file added .github/media/create_release.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed .github/media/draft_release.png
Binary file not shown.
Binary file removed .github/media/github_release.png
Binary file not shown.
Binary file added .github/media/home_to_release.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/media/release.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed .github/media/release_review.png
Binary file not shown.
Binary file added .github/media/releases_list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
29 changes: 16 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,25 +69,28 @@ Upon release of a new major version from JetBrains, the plugin needs updated dep

Follow the steps outlined here:

![](.github/media/github_release.png)

1. Go to the GitHub "_Actions_" tab on the Orion repository
2. Select the "_Release_" workflow
3. Click on "_Run workflow_" and input the new version number to release (e.g. `1.5.0` releases and tags version `v1.5.0`)
4. An admin now has to review and accept the new release by viewing the created workflow run
![](.github/media/release_review.png)
5. After the release is approved, GitHub will automatically build and upload the artifact. It will also create a new draft of the GitHub release
6. An admin must promote the GitHub draft release to properly tag and release the latest build on GitHub.
1. Go to the releases page and open the generated latest draft release of Orion
2. Update the changelog by copy-pasting the information into the description box
3. Click on 'Publish release' to finish the process
![](.github/media/draft_release.png)
![](.github/media/home_to_release.png)

1. Go to the GitHub "_Releases_" in the Orion repository
2. Click on "_Draft a new release_"

![](.github/media/releases_list.png)

3. Choose as a tag the new version number to release (e.g. tag version `v1.5.0` releases the version `1.5.0`)
4. Let the release notes be auto-generated by clicking `Generate release notes`

![](.github/media/create_release.png)

5. An admin now has to review and accept the new release
6. After the release is approved, GitHub will automatically build and upload the artifact as well as publish the new version to the marketplace.

The latest plugin artifact is now available on GitHub and via the JetBrains marketplace.

**It might take some time for the latest version to be seen on the marketplace since JetBrains still has to review
and approve the changes!**

![](.github/media/release.gif)

### Release Process Implementation

**How can I modify the pipeline?**
Expand Down