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

Update release README #466

Merged
merged 1 commit into from
Mar 3, 2020
Merged

Update release README #466

merged 1 commit into from
Mar 3, 2020

Conversation

ncskier
Copy link
Member

@ncskier ncskier commented Mar 2, 2020

Changes

Add Task to create a draft release in GitHub with all of the commits and
authors.

Update release README with instructions about running the draft release
Task.

Submitter Checklist

These are the criteria that every PR should meet, please check them off as you
review them:

See the contribution guide for more details.

@ncskier ncskier requested a review from dibyom March 2, 2020 20:32
@tekton-robot tekton-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Mar 2, 2020
Copy link
Member

@dibyom dibyom left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Couple of small things but the create draft task is a really nice addition that will reduce a lot of toil for the release manager! Thanks!

tekton/README.md Show resolved Hide resolved
tekton/README.md Outdated

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, arranging PRs in the right category, highlighting important changes.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Once the draft release is created, the release manager needs to edit the draft, arranging PRs in the right category, highlighting 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.

tekton/README.md Outdated

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

This Task expects a secret named `github-token` to exists, with a GitHub token in `GITHUB_TOKEN` with enough privileges to list PRs and create a draft release.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This Task expects a secret named `github-token` to exists, with a GitHub token in `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.

tekton/README.md Outdated
tkn task start \
-i source=tekton-triggers-git \
-p package=tektoncd/triggers \
-p release-tag=v0.3.1 \
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we change this to v.x.yz. or follow the convention below where it is set via an environment variable? (Mainly to prevent the inevitable scenario when someone (read I) copy pastes the entire thing overwriting/creating additional drafts)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep, good point 😅

tekton/README.md Outdated
- name: url
value: https://github.com/tektoncd/triggers
- name: revision
value: master # REPLACE with the commit you want to release
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same as above; might be useful to set to invalid value to prevent unintended copy paste.

Add Task to create a draft release in GitHub with all of the commits and
authors.

Update release README with instructions about running the draft release
Task.
@ncskier
Copy link
Member Author

ncskier commented Mar 3, 2020

Thanks for the feedback @dibyom 👍 I think I've addressed everything; let me know what you think.

@dibyom
Copy link
Member

dibyom commented Mar 3, 2020

/approve
/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Mar 3, 2020
@tekton-robot
Copy link

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: dibyom

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@tekton-robot tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 3, 2020
@tekton-robot tekton-robot merged commit 2356305 into tektoncd:master Mar 3, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cla: yes lgtm Indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants