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

Elaborate on documentation for JetBrains releases #1452

Merged
merged 1 commit into from
May 6, 2024
Merged

Conversation

olafurpg
Copy link
Member

@olafurpg olafurpg commented May 6, 2024

Test plan

Only changing docs.

@olafurpg olafurpg requested a review from pkukielka May 6, 2024 14:17
@olafurpg olafurpg enabled auto-merge (squash) May 6, 2024 14:19
graph TD;
Title["JetBrains plugin release"] --> stable;
Title --> nightly;
stable --> push_stable["push git tag"];
Copy link
Contributor

@pkukielka pkukielka May 6, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Today we are using ./scripts/push-git-tag-for-next-release.sh for that (it have some safeguards and also suggests you proper release branch name):

➜  jetbrains git:(pkukielka/move-session-lifecyccle-management-to-agent) ✗ ./scripts/push-git-tag-for-next-release.sh --patch
++ git symbolic-ref --short HEAD
+ CURRENT_BRANCH=pkukielka/move-session-lifecyccle-management-to-agent
+ '[' pkukielka/move-session-lifecyccle-management-to-agent '!=' main ']'
+ echo 'Warning: You are not on the '\''main'\'' branch. You are on '\''pkukielka/move-session-lifecyccle-management-to-agent'\''.'
Warning: You are not on the 'main' branch. You are on 'pkukielka/move-session-lifecyccle-management-to-agent'.
+ read -p 'Are you sure you want to proceed? (y/n): ' proceed
Are you sure you want to proceed? (y/n):

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is mentioned in the "push a git tag" section below the diagram.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, it was not expanded in the diff and I missed it, thanks!

Copy link
Contributor

@pkukielka pkukielka left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@olafurpg olafurpg merged commit c13b40e into main May 6, 2024
5 checks passed
@olafurpg olafurpg deleted the olafurpg/releases branch May 6, 2024 14:49
steveyegge pushed a commit that referenced this pull request May 9, 2024
## Test plan

Only changing  docs.
<!-- All pull requests REQUIRE a test plan:
https://sourcegraph.com/docs/dev/background-information/testing_principles

Why does it matter?

These test plans are there to demonstrate that are following industry
standards which are important or critical for our customers.
They might be read by customers or an auditor. There are meant be simple
and easy to read. Simply explain what you did to ensure
your changes are correct!

Here are a non exhaustive list of test plan examples to help you:

- Making changes on a given feature or component:
- "Covered by existing tests" or "CI" for the shortest possible plan if
there is zero ambiguity
  - "Added new tests"
- "Manually tested" (if non trivial, share some output, logs, or
screenshot)
- Updating docs:
  - "previewed locally"
  - share a screenshot if you want to be thorough
- Updating deps, that would typically fail immediately in CI if
incorrect
  - "CI"
  - "locally tested"
-->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants