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

Add entry in PR description asking Pull Requesters to document any new commands they add #2688

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

moskyb
Copy link
Contributor

@moskyb moskyb commented Mar 12, 2024

Description

The current (internal) guidance is that when a buildkite employee makes a new release of the agent, they open a PR against the docs that includes updates in CLI reference there, which is kinda-sorta autogenerated from the helptexts that we write for commands in this repo.

the issue with this process is that the process for adding a new page for a new agent cli command is a bit involved, and often it leaves the person who made the release in charge of adding docs for a command they didn't write, which is a minor pain.

this PR adds another couple of checkboxes to the PR description (the one i'm typing in right now!) asking that if the user has added a command, that they open a PR against the docs repo. i also added a checkbox for "updated the readme as necessary", because the other checkbox was looking lonely on its own

Context

buildkite/docs#2710

Testing

  • Tests have run locally (with go test ./...). Buildkite employees may check this if the pipeline has run automatically.
  • Code is formatted (with go fmt ./...)

@moskyb moskyb requested a review from a team March 12, 2024 04:47
Copy link
Contributor

@triarius triarius Mar 12, 2024

Choose a reason for hiding this comment

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

The docs repo is public too yeah? I think this document belongs there as most of the commands assume the working directory is a docs repo.

1. Clone or change direcotry to the docs repo: https://github.com/buildkite/docs.git
2. Follow the instructions in https://github.com/buildkite/docs?tab=readme-ov-file#agent

I suggested putting it in an agent section in the README as there is no docs directory in the docs repo for documentation on the documentation! You could create one if you want. I think it's a good precedent to set.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants