Skip to content

Commit

Permalink
Format markdown
Browse files Browse the repository at this point in the history
Produced via:
  `prettier --write --prose-wrap=always $(find -name '*.md' | grep -v vendor | grep -v .github)`
/assign ImJasonH dibyom
/cc ImJasonH dibyom
  • Loading branch information
mattmoor authored and tekton-robot committed Mar 4, 2020
1 parent 2356305 commit 820d8b3
Showing 1 changed file with 12 additions and 6 deletions.
18 changes: 12 additions & 6 deletions tekton/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,11 +49,15 @@ To make a new release:

### Create draft release

The Task `create-draft-triggers-release` calculates the list of PRs merged between the previous release and a specified revision. It also builds a list of authors and uses PRs and authors to build a draft new release in GitHub.
The Task `create-draft-triggers-release` calculates the list of PRs merged
between the previous release and a specified revision. It also builds a list of
authors and uses PRs and authors to build a draft new release in GitHub.

Running this Task multiple times will create multiple drafts; old drafts have to be pruned manually when needed.
Running this Task multiple times will create multiple drafts; old drafts have to
be pruned manually when needed.

Once the draft release is created, the release manager needs to edit the draft, arrange PRs in the right category, and highlight important changes.
Once the draft release is created, the release manager needs to edit the draft,
arrange PRs in the right category, and highlight important changes.

Parameters:

Expand All @@ -65,7 +69,9 @@ Resources:

- `source`, a git resource that points to the release git revision

This Task expects a secret named `github-token` with a key called `GITHUB_TOKEN` to exist. The value should be a GitHub token with enough privileges to list PRs and create a draft release.
This Task expects a secret named `github-token` with a key called `GITHUB_TOKEN`
to exist. The value should be a GitHub token with enough privileges to list PRs
and create a draft release.

```bash
export PREV_VERSION_TAG=v0.X.Y
Expand All @@ -81,8 +87,8 @@ tkn task start \

### Run the Pipeline

To use [`tkn`](https://github.com/tektoncd/cli) to run the
`triggers-release` PipelineRun and create a release:
To use [`tkn`](https://github.com/tektoncd/cli) to run the `triggers-release`
PipelineRun and create a release:

1. Pick the revision you want to release and update the
[`resources.yaml`](./resources.yaml) file to add a `PipelineResoruce` for it,
Expand Down

0 comments on commit 820d8b3

Please sign in to comment.