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

Prepare to ship v-0.28.0 docs #653

Merged
merged 7 commits into from
Jul 5, 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
35 changes: 34 additions & 1 deletion src/markdown-pages/docs/first-steps/initialising-home-folder.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,25 @@ The following section shows you how to initialise your Galasa home folder by usi

You can view the full list of options (flags) that are available with the `local init` command in the [Galasa cli repository](https://github.com/galasa-dev/cli/blob/main/docs/generated/galasactl_local_init.md).


## Setting the Galasa bootstrap

Most Galasa CLI commands need a reference to the Galasa bootstrap file or URL. You can set the bootstrap either by using the `--bootstrap` option on the CLI command or by setting the `GALASA_BOOTSTRAP` environment variable. If both are provided, the `--bootstrap` option takes precedence.

You can set environment variables on a terminal by using the `export` (if you are on Mac or Linux) or `set` (if you are on Windows) command. For example, to set `GALASA_BOOTSTRAP` to `http://my-bootstrap-url`, use the following command:

On Mac or Unix:

```
export GALASA_BOOTSTRAP=http://my-bootstrap-url
```

On Windows:

```
set GALASA_BOOTSTRAP=http://my-bootstrap-url
```

## Initialising the Galasa home folder

To initialise your Galasa home folder in your home directory along with the properties files, use the following command:
Expand Down Expand Up @@ -39,7 +58,21 @@ The `${HOME}/.galasa` folder is a writable folder and is used by default to stor

This value can be overridden using the `GALASA_HOME` environment variable. Setting this variable means that you can control where files are created, where Galasa retrieves settings from, and where local test run results and artifacts are stored. This is useful if you need isolation between multiple Galasa local test environments, if you want to share your configuration and test run results with others, or if your `${HOME}/.galasa` folder is low on disk space.

You can override the value of the `GALASA_HOME` environment variable on a call-by-call basis by using the `--galasahome` command-line flag.
For example, to set the `GALASA_HOME` environment variable to a folder called _mygalasatests_ in a directory called _temp_, use the following command:

On Mac or Unix:

```
export GALASA_HOME=/temp/mygalasatests
```

On Windows:

```
set GALASA_HOME=C:\temp\mygalasatests
```

You can override the value of the `GALASA_HOME` environment variable on a call-by-call basis by using the `--galasahome` command-line option.

If you change the `GALASA_HOME` variable to a non-existent or non-initialised folder path, you can create the folder and re-initialise the folder path by running the `galasactl local init` command.

Expand Down
9 changes: 7 additions & 2 deletions src/markdown-pages/highlights.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,18 @@ Post a question or share your experiences with other users in our <a href="https
Access the Galasa source code in [GitHub](https://github.com/galasa-dev) and open issues in the [project management repository](https://github.com/galasa-dev/projectmanagement).


## 0.28.0 - Release Highlights
## 0.29.0 - Release Highlights

- Upgrade of 'bouncy castle' crypto libraries to remove a security vulnerability.

<details>
<summary><b>0.28.0 - Release Highlights</b></summary>

- Updates to the `runs get` command, including the ability to filter test run results on a specified time period, and to display the returned results in a detailed or raw format
- Ability to download test run artifacts by using the `runs download` command
- Ability to debug a test locally by using the `runs submit local` command
- Various documentation updates and enhancements

</details>

<details>
<summary><b>0.27.0 - Release Highlights</b></summary>
Expand Down
2 changes: 1 addition & 1 deletion src/pages/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ const IndexPage = () => (
Learn more
</Button>
<Button target={"/releases"} flash={true} isPrimary={true}>
0.28.0 highlights
0.29.0 highlights
</Button>
</div>
</div>
Expand Down