Update default branch from master to main

Open
#21 4 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-2 days
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
bash, git
Domain
devops, documentation

Research direction

Check the bash-example repository's default branch and compare the getting started documentation's “Add the sample pipeline” step 5 with the proposed wording. Also review the linked powershell-example repository for its branch setup; done means the repository default and instructions no longer conflict for new users.

Written by the indexing model from the issue text.

Description

Hi Buildkite 👋

I'm going through the getting started guide and created my first agent with the bash example. I encountered a hurdle when running my first build. The pipeline defaults expect main as the default branch but only master exists on this repository.

I think two things can be done here to get your documentation in sync with the example repositories:

  1. We could update repository's default to main
  2. We could tweak the getting started documentation a little bit on point number 5 of the section Add the sample pipeline (see screenshot below)

1. Default branch: main

My guess is that you now default all repository branches to main when creating pipelines (which is 👍) but this repository still has master as the default and new users trying out agents don't necessarily know that. The other getting started repository powershell-example has main as its default branch so all good there.

Here are screenshots of the issue:

CleanShot 2021-11-07 at 13 09 31@2x CleanShot 2021-11-07 at 12 58 37@2x

2. Documentation update

The documentation seems to suggest that master is still the default for repositories and conflicts with Buildkite pipeline defaults. The doc could be updated to:

You can usually accept the defaults here. If your repository uses 'master' rather than 'main' branch, edit the Branch option. Select Create build. Buildkite takes you to the pipeline build.

Current documentation
CleanShot 2021-11-07 at 12 59 39@2x
Dominant language
Shell
Stars
24
Forks
196
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from buildkite/bash-example

All issues in buildkite/bash-example

Similar issues

More Shell/Bash issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.