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

[Chore] Update release docs #482

Merged
merged 1 commit into from
Nov 16, 2023
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
28 changes: 28 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,3 +41,31 @@ npm test
```

This will start the release process. Wait for an email/slack to confirm the release is done.

### Criteria for publishing

#### Manual testing

Before publishing a release there are a few basic criteria.
In order to generate a release binary, the build pipeline will have already run all tests and successfully signed
the artifacts for macOS, Windows, and Linux.

Thus, the only real confirmation step required is to run the actual release binaries before publishing.
As of now, this is a rather informal process where we solicit help from team members who run on each platform.
It would be a much nicer process in future releases to ensure we have an easy-access, centralized way for anyone
on the team that maintains the Recorder to quickly download and run the binaries.

Once someone has ensured that the following are true, there's nothing blocking the new version from release.

1. The Recorder loads without warning the user that the code is unsigned/dangerous.
1. The Recorder app opens.
1. You are able to record a session.
1. You are able to use the Test feature and see Playwright replicate your journey.
- **Note:** the Recorder is a basic tool, and is not capable of fully mapping all arbitrary browser sessions.
It is easy to make a path that causes it to record code that may not run perfectly.
An all-encompassing recording feature set is not currently within the design goals of this app.
A single broken journey not necessarily disqualify the release, we should take note of things
that break the recorder and try to address them in the future.
1. You are able to export code.
1. Ideally, you take the code you export and run it in an actual monitor in a Kibana or Project.
justinkambic marked this conversation as resolved.
Show resolved Hide resolved
- **Note:** if you use this in Kibana's Synthetics UI you must export as an `inline` script.
14 changes: 7 additions & 7 deletions docs/DOWNLOAD.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# Elastic Synthetic Monitoring Point and Click Script Recorder Download Page

**Current Version:** 1.2.0 Released 7 September 2023
**Current Version:** 1.3.0 Released 13 November 2023

## Download Links

- [MacOS (Intel)](https://download.elasticsearch.org/synthetics-recorder/synthetics-recorder-1.2.0-mac-x64.dmg)
- [MacOS (Apple Silicon)](https://download.elasticsearch.org/synthetics-recorder/synthetics-recorder-1.2.0-mac-arm64.dmg)
- [Windows](https://download.elasticsearch.org/synthetics-recorder/synthetics-recorder-1.2.0-win-x64.exe)
- [Linux](https://download.elasticsearch.org/synthetics-recorder/synthetics-recorder-1.2.0-linux-amd64.deb)
- [MacOS (Intel)](https://download.elasticsearch.org/synthetics-recorder/synthetics-recorder-1.3.0-mac-x64.dmg)
- [MacOS (Apple Silicon)](https://download.elasticsearch.org/synthetics-recorder/synthetics-recorder-1.3.0-mac-arm64.dmg)
- [Windows](https://download.elasticsearch.org/synthetics-recorder/synthetics-recorder-1.3.0-win-x64.exe)
- [Linux](https://download.elasticsearch.org/synthetics-recorder/synthetics-recorder-1.3.0-linux-amd64.deb)

## Supported Systems

- macOS (High Sierra and up): 64-bit Intel and ARM (Apple Silicon M1 & M2) for macOS
- macOS (High Sierra and up): 64-bit Intel and ARM (Apple Silicon) for macOS
- Windows (Windows 10 and up): x64
- Linux: _Verified to work on_ Ubuntu 14.04 and newer
- Linux: Ubuntu 14.04 and newer