151 lines
4.5 KiB
Markdown
151 lines
4.5 KiB
Markdown
# GitLab Releases Resource
|
|
|
|
~~Fetches and creates versioned GitLab resources.~~
|
|
|
|
Note that this is still in development, and doesn't yet work. It will hopefully be ready later this week.
|
|
|
|
## Source Configuration
|
|
|
|
* `repository`: *Required.* The repository name that contains the releases.
|
|
|
|
* `access_token`: *Required.* Used for accessing a release in a private-repo
|
|
during an `in` and pushing a release to a repo during an `out`. The access
|
|
token you create is only required to have the `repo` or `public_repo` scope.
|
|
|
|
* `github_api_url`: *Optional.* If you use a non-public GitHub deployment then
|
|
you can set your API URL here.
|
|
|
|
* `insecure`: *Optional. Default `false`.* When set to `true`, concourse will allow
|
|
insecure connection to your github API.
|
|
|
|
* `tag_filter`: *Optional.* If set, override default tag filter regular
|
|
expression of `v?([^v].*)`. If the filter includes a capture group, the capture
|
|
group is used as the release version; otherwise, the entire matching substring
|
|
is used as the version.
|
|
|
|
### Example
|
|
|
|
``` yaml
|
|
- name: gh-release
|
|
type: github-release
|
|
source:
|
|
owner: concourse
|
|
repository: concourse
|
|
access_token: abcdef1234567890
|
|
```
|
|
|
|
``` yaml
|
|
- get: gh-release
|
|
```
|
|
|
|
``` yaml
|
|
- put: gh-release
|
|
params:
|
|
name: path/to/name/file
|
|
tag: path/to/tag/file
|
|
body: path/to/body/file
|
|
globs:
|
|
- paths/to/files/to/upload-*.tgz
|
|
```
|
|
|
|
To get a specific version of a release:
|
|
|
|
``` yaml
|
|
- get: gh-release
|
|
version: { tag: 'v0.0.1' }
|
|
```
|
|
|
|
To set a custom tag filter:
|
|
|
|
```yaml
|
|
- name: gh-release
|
|
type: github-release
|
|
source:
|
|
owner: concourse
|
|
repository: concourse
|
|
tag_filter: "version-(.*)"
|
|
```
|
|
|
|
## Behavior
|
|
|
|
### `check`: Check for released versions.
|
|
|
|
Releases are listed and sorted by their tag, using
|
|
[semver](http://semver.org) semantics if possible. If `version` is specified, `check` returns releases from the specified version on. Otherwise, `check` returns the latest release.
|
|
|
|
### `in`: Fetch assets from a release.
|
|
|
|
Fetches artifacts from the given release version. If the version is not
|
|
specified, the latest version is chosen using [semver](http://semver.org)
|
|
semantics.
|
|
|
|
Also creates the following files:
|
|
|
|
* `tag` containing the git tag name of the release being fetched.
|
|
* `version` containing the version determined by the git tag of the release being fetched.
|
|
* `body` containing the body text of the release.
|
|
* `commit_sha` containing the commit SHA the tag is pointing to.
|
|
|
|
#### Parameters
|
|
|
|
* `globs`: *Optional.* A list of globs for files that will be downloaded from
|
|
the release. If not specified, all assets will be fetched.
|
|
|
|
* `include_source_tarball`: *Optional.* Enables downloading of the source
|
|
artifact tarball for the release as `source.tar.gz`. Defaults to `false`.
|
|
|
|
* `include_source_zip`: *Optional.* Enables downloading of the source
|
|
artifact zip for the release as `source.zip`. Defaults to `false`.
|
|
|
|
### `out`: Publish a release.
|
|
|
|
Given a name specified in `name`, a body specified in `body`, and the tag to use
|
|
specified in `tag`, this creates a release on GitHub then uploads the files
|
|
matching the patterns in `globs` to the release.
|
|
|
|
#### Parameters
|
|
|
|
* `name`: *Required.* A path to a file containing the name of the release.
|
|
|
|
* `tag`: *Required.* A path to a file containing the name of the Git tag to use
|
|
for the release.
|
|
|
|
* `tag_prefix`: *Optional.* If specified, the tag read from the file will be
|
|
prepended with this string. This is useful for adding v in front of version numbers.
|
|
|
|
* `commitish`: *Optional.* A path to a file containing the commitish (SHA, tag,
|
|
branch name) that the release should be associated with.
|
|
|
|
* `body`: *Optional.* A path to a file containing the body text of the release.
|
|
|
|
* `globs`: *Optional.* A list of globs for files that will be uploaded alongside
|
|
the created release.
|
|
|
|
## Development
|
|
|
|
### Prerequisites
|
|
|
|
* golang is *required* - version 1.9.x is tested; earlier versions may also
|
|
work.
|
|
* docker is *required* - version 17.06.x is tested; earlier versions may also
|
|
work.
|
|
* godep is used for dependency management of the golang packages.
|
|
|
|
### Running the tests
|
|
|
|
The tests have been embedded with the `Dockerfile`; ensuring that the testing
|
|
environment is consistent across any `docker` enabled platform. When the docker
|
|
image builds, the test are run inside the docker container, on failure they
|
|
will stop the build.
|
|
|
|
Run the tests with the following command:
|
|
|
|
```sh
|
|
docker build -t github-release-resource .
|
|
```
|
|
|
|
### Contributing
|
|
|
|
Please make all pull requests to the `master` branch and ensure tests pass
|
|
locally.
|