Skip to content

Commit eec59a0

Browse files
committed
Rename default branch to 'main'
Update links to use new name. Also leave a note to change the default branch name for the contribution banner link; we can't change this without it being a breaking change for users.
1 parent 007096e commit eec59a0

File tree

3 files changed

+10
-10
lines changed

3 files changed

+10
-10
lines changed

CHANGELOG.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -422,7 +422,7 @@ which item is selected in the navigation.
422422
More info:
423423

424424
- https://github.com/alphagov/tech-docs-gem/pull/19
425-
- https://github.com/alphagov/tech-docs-gem/blob/master/docs/frontmatter.md#parent
425+
- https://github.com/alphagov/tech-docs-gem/blob/main/docs/frontmatter.md#parent
426426

427427
## 1.2.0
428428

@@ -434,24 +434,24 @@ You can use this when you change a page URL.
434434

435435
More info:
436436

437-
- https://github.com/alphagov/tech-docs-gem/blob/master/docs/configuration.md#redirects
438-
- https://github.com/alphagov/tech-docs-gem/blob/master/docs/frontmatter.md#old_paths
437+
- https://github.com/alphagov/tech-docs-gem/blob/main/docs/configuration.md#redirects
438+
- https://github.com/alphagov/tech-docs-gem/blob/main/docs/frontmatter.md#old_paths
439439

440440
### New feature: contribution banner
441441

442442
You can now show a block at the bottom of the page that links to
443443
the page source on GitHub, so readers can easily contribute back to the documentation.
444444

445-
https://github.com/alphagov/tech-docs-gem/blob/master/docs/configuration.md#show_contribution_banner
445+
https://github.com/alphagov/tech-docs-gem/blob/main/docs/configuration.md#show_contribution_banner
446446

447447
### New feature: page review system
448448

449449
An optional page review system to make sure documentation stays up to date.
450450

451451
More info:
452452

453-
- https://github.com/alphagov/tech-docs-gem/blob/master/docs/frontmatter.md#last_reviewed_on
454-
- https://github.com/alphagov/tech-docs-gem/blob/master/docs/frontmatter.md#owner_slack
453+
- https://github.com/alphagov/tech-docs-gem/blob/main/docs/frontmatter.md#last_reviewed_on
454+
- https://github.com/alphagov/tech-docs-gem/blob/main/docs/frontmatter.md#owner_slack
455455

456456

457457
### Better meta tags
@@ -463,7 +463,7 @@ Pages now include better meta tags for search engines, Twitter, Facebook and Sla
463463
You can now specify `google_site_verification` in tech-docs.yml. You can use
464464
this to verify your site in Google Webmaster tools.
465465

466-
https://github.com/alphagov/tech-docs-gem/blob/master/docs/configuration.md#google_site_verification
466+
https://github.com/alphagov/tech-docs-gem/blob/main/docs/configuration.md#google_site_verification
467467

468468
## 1.0.0
469469

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Find out how to [contribute](https://tdt-documentation.london.cloudapps.digital/
1515

1616
This gem uses [GOV.UK Frontend](https://github.com/alphagov/govuk-frontend), part of the [GOV.UK Design System](https://design-system.service.gov.uk/).
1717

18-
We use `npm` to download the govuk-frontend package. To update to a new version, change the version in the [package.json file](blob/master/package.json) and run `npm update`.
18+
We use `npm` to download the govuk-frontend package. To update to a new version, change the version in the [package.json file](blob/main/package.json) and run `npm update`.
1919

2020
## Developing locally
2121

@@ -96,7 +96,7 @@ The documentation is [© Crown copyright][copyright] and available under the ter
9696
[ogl]: http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/
9797
[tdt-docs]: https://tdt-documentation.london.cloudapps.digital
9898
[tdt-template]: https://github.com/alphagov/tech-docs-template
99-
[tdt-readme]: https://github.com/alphagov/tech-docs-template/blob/master/README.md
99+
[tdt-readme]: https://github.com/alphagov/tech-docs-template/blob/main/README.md
100100
[mmt]: https://middlemanapp.com/advanced/project_templates/
101101

102102
[jas]: https://jasmine.github.io/

lib/govuk_tech_docs/contribution_banner.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ def repo_url
3939
end
4040

4141
def repo_branch
42-
config[:tech_docs][:github_branch] || "master"
42+
config[:tech_docs][:github_branch] || "master" # TODO: change this to 'main' in a future breaking release
4343
end
4444

4545
private

0 commit comments

Comments
 (0)