agola/doc/devel.md

### Local development

#### Start the web interface

- Clone the [agola-web repository](https://github.com/agola-io/agola-web)

For the first time you'll need the `vue cli` and its services installed as global modules:

```
npm install -g @vue/cli @vue/cli-service-global
```

Inside the `agola-web` repository run:

```
npm install
npm run serve
```

### Build the agola binary

To build agola we usually test and support the latest two major versions of Go like in the [Go release policy](https://golang.org/doc/devel/release.html#policy).

```
make
```

### Start the agola server

- Copy the `example/config.yml` where you prefer

```
./bin/agola serve --embedded-etcd --config /path/to/your/config.yml --components all-base,executor
```

or use an external etcd (set it in the config.yml):

```
./bin/agola serve --config /path/to/your/config.yml --components all-base,executor
```

### Error handling

Use the `--detailed-errors` option to easily follow the errors chain.

When developing you should wrap every error using `errors.Wrap[f]` or `errors.WithStack`. The ci uses `golangci-lint` with the `wrapcheck` linter enabled to check if some errors aren't wrapped.
README: add local development doc and agola demo link 2019-07-02 08:54:44 +00:00			`### Local development`

			`#### Start the web interface`

: use new errors handling library Implement a new error handling library based on pkg/errors. It provides stack saving on wrapping and exports some function to add stack saving also to external errors. It also implements custom zerolog error formatting without adding too much verbosity by just printing the chain error file:line without a full stack trace of every error. Add a --detailed-errors options to print error with they full chain * Wrap all error returns. Use errors.WithStack to wrap without adding a new messsage and error.Wrap[f] to add a message. * Add golangci-lint wrapcheck to check that external packages errors are wrapped. This won't check that internal packages error are wrapped. But we want also to ensure this case so we'll have to find something else to check also these. 2022-02-22 14:01:29 +00:00			`- Clone the [agola-web repository](https://github.com/agola-io/agola-web)`
README: add local development doc and agola demo link 2019-07-02 08:54:44 +00:00
			For the first time you'll need the `vue cli` and its services installed as global modules:

			```
			`npm install -g @vue/cli @vue/cli-service-global`
			```

			Inside the `agola-web` repository run:

			```
			`npm install`
			`npm run serve`
			```

			`### Build the agola binary`

doc: document supported go versions. We usually test and support the latest two major versions of Go like in the [Go release policy](https://golang.org/doc/devel/release.html#policy). 2020-01-24 12:53:13 +00:00			`To build agola we usually test and support the latest two major versions of Go like in the [Go release policy](https://golang.org/doc/devel/release.html#policy).`

README: add local development doc and agola demo link 2019-07-02 08:54:44 +00:00			```
			`make`
			```

			`### Start the agola server`

: use new errors handling library Implement a new error handling library based on pkg/errors. It provides stack saving on wrapping and exports some function to add stack saving also to external errors. It also implements custom zerolog error formatting without adding too much verbosity by just printing the chain error file:line without a full stack trace of every error. Add a --detailed-errors options to print error with they full chain * Wrap all error returns. Use errors.WithStack to wrap without adding a new messsage and error.Wrap[f] to add a message. * Add golangci-lint wrapcheck to check that external packages errors are wrapped. This won't check that internal packages error are wrapped. But we want also to ensure this case so we'll have to find something else to check also these. 2022-02-22 14:01:29 +00:00			- Copy the `example/config.yml` where you prefer
README: add local development doc and agola demo link 2019-07-02 08:54:44 +00:00
			```
update example in devel doc 2019-08-19 08:16:54 +00:00			`./bin/agola serve --embedded-etcd --config /path/to/your/config.yml --components all-base,executor`
README: add local development doc and agola demo link 2019-07-02 08:54:44 +00:00			```

			`or use an external etcd (set it in the config.yml):`

			```
update example in devel doc 2019-08-19 08:16:54 +00:00			`./bin/agola serve --config /path/to/your/config.yml --components all-base,executor`
README: add local development doc and agola demo link 2019-07-02 08:54:44 +00:00			```
: use new errors handling library Implement a new error handling library based on pkg/errors. It provides stack saving on wrapping and exports some function to add stack saving also to external errors. It also implements custom zerolog error formatting without adding too much verbosity by just printing the chain error file:line without a full stack trace of every error. Add a --detailed-errors options to print error with they full chain * Wrap all error returns. Use errors.WithStack to wrap without adding a new messsage and error.Wrap[f] to add a message. * Add golangci-lint wrapcheck to check that external packages errors are wrapped. This won't check that internal packages error are wrapped. But we want also to ensure this case so we'll have to find something else to check also these. 2022-02-22 14:01:29 +00:00
			`### Error handling`

			Use the `--detailed-errors` option to easily follow the errors chain.

			When developing you should wrap every error using `errors.Wrap[f]` or `errors.WithStack`. The ci uses `golangci-lint` with the `wrapcheck` linter enabled to check if some errors aren't wrapped.