From a14210cfd8b0a6a13e27320259caf698bf8068ea Mon Sep 17 00:00:00 2001 From: John Ricords <122303445+johnricords@users.noreply.github.com> Date: Wed, 6 Mar 2024 12:21:40 -0500 Subject: [PATCH 1/6] added config settings --- .bumpversion.cfg | 2 +- LICENSE | 2 +- README.md | 31 +++++++++++++++++++++++++++++-- 3 files changed, 31 insertions(+), 4 deletions(-) diff --git a/.bumpversion.cfg b/.bumpversion.cfg index a5731e4..027e002 100644 --- a/.bumpversion.cfg +++ b/.bumpversion.cfg @@ -1,5 +1,5 @@ [bumpversion] -current_version = 1.2.0 +current_version = 1.2.1 commit = True message = Bumps version to {new_version} tag = False diff --git a/LICENSE b/LICENSE index 598c4b8..c2f93d6 100644 --- a/LICENSE +++ b/LICENSE @@ -186,7 +186,7 @@ same "printed page" as the copyright notice for easier identification within third-party archives. - Copyright 2023 Maintainers of plus3it/repo-template + Copyright 2024 Maintainers of plus3it/repo-template Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. diff --git a/README.md b/README.md index ceff70c..2d37559 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,34 @@ To use this template: 1. Select the green "Use this template" button, or [click here](https://github.com/plus3it/repo-template/generate). 2. Select the repo Owner, give the repo a name, enter a description, select Public or Private, and click "Create repository from template". 3. Clone the repository and create a new branch. -4. Edit the following files to customize them for the new repository: +4. Configure the following settings on your new repo. + * `GENERAL` + * `Features` + * Turn off Wikis + * `Pull Requests` + * Turn off Squash Merging + * Turn off Rebase Merging + * Turn on Allow Auto-Merge + * Turn on Automatically delete head branches + * `Pushes` + * Limit how many branches can be updated in a single push: 2 + * `COLLABORATORS and TEAMS` + * `Manage Access` + * Add relevant team roles, for example + * `tardigrade-admins` (as admin) + * `terraform` (as maintainer) + * `Branches` + * `Create Branch Protection rule` + * Turn on Require pull request before merging + * Turn on Require approvals + * Turn on Dismiss stale pull requests... + * `Required Status Checks` + * As relevant to projects, for example + * WIP + * lint/actionlint + * lint/tardigradelint + * release / test / mockstacktest +5. Edit the following files to customize them for the new repository: * `LICENSE` * Near the end of the file, edit the date and change the repository name * `CHANGELOG.template.md` @@ -20,4 +47,4 @@ To use this template: * `.github/` * Inspect dependabot and workflow files in case changes are needed for the new repo -5. Commit the changes and open a pull request +6. Commit the changes and open a pull request From b656bafac4194f1491a174bfaa8156bda5131e20 Mon Sep 17 00:00:00 2001 From: John Ricords <122303445+johnricords@users.noreply.github.com> Date: Wed, 6 Mar 2024 12:26:31 -0500 Subject: [PATCH 2/6] changelog entry --- CHANGELOG.md | 7 +++++++ README.md | 1 + 2 files changed, 8 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 222e408..5caad15 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,13 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](http://semver.org/). +### [1.2.1] (https://github.com/plus3it/repo-template/releases/tag/1.2.1) + +**Summary**: + +* Updated README.md to include config settings for github +* Updated LICENSE copyright year + ### [1.2.0] (https://github.com/plus3it/repo-template/releases/tag/1.2.0) **Summary**: diff --git a/README.md b/README.md index 2d37559..50e5d69 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,7 @@ To use this template: * lint/actionlint * lint/tardigradelint * release / test / mockstacktest + * Turn on Do not allow bypassing the above settings 5. Edit the following files to customize them for the new repository: * `LICENSE` * Near the end of the file, edit the date and change the repository name From d720958bf6ad4fc345b13b76c12d3949499c87be Mon Sep 17 00:00:00 2001 From: johnricords <122303445+johnricords@users.noreply.github.com> Date: Thu, 7 Mar 2024 14:39:50 -0500 Subject: [PATCH 3/6] Update README.md Co-authored-by: Loren Gordon --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 50e5d69..40004cc 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ To use this template: * WIP * lint/actionlint * lint/tardigradelint - * release / test / mockstacktest + * test / mockstacktest * Turn on Do not allow bypassing the above settings 5. Edit the following files to customize them for the new repository: * `LICENSE` From 11ddfcce0dd22f455a7ee900168750ea20bf4227 Mon Sep 17 00:00:00 2001 From: johnricords <122303445+johnricords@users.noreply.github.com> Date: Thu, 7 Mar 2024 14:39:56 -0500 Subject: [PATCH 4/6] Update README.md Co-authored-by: Loren Gordon --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 40004cc..35f7456 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ To use this template: 4. Configure the following settings on your new repo. * `GENERAL` * `Features` - * Turn off Wikis + * Turn off Wikis, Sponsorships, Discussions, and Projects * `Pull Requests` * Turn off Squash Merging * Turn off Rebase Merging From 94885dc8381affbb07ef345b9dfad39afa05081f Mon Sep 17 00:00:00 2001 From: johnricords <122303445+johnricords@users.noreply.github.com> Date: Thu, 7 Mar 2024 14:40:02 -0500 Subject: [PATCH 5/6] Update README.md Co-authored-by: Loren Gordon --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 35f7456..75c073b 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ To use this template: * `tardigrade-admins` (as admin) * `terraform` (as maintainer) * `Branches` - * `Create Branch Protection rule` + * `Create Branch Protection rule` for `main` * Turn on Require pull request before merging * Turn on Require approvals * Turn on Dismiss stale pull requests... From 5d394f92f6037aa2ffbcc51009224ee5608e1187 Mon Sep 17 00:00:00 2001 From: johnricords <122303445+johnricords@users.noreply.github.com> Date: Thu, 7 Mar 2024 14:40:14 -0500 Subject: [PATCH 6/6] Update README.md Co-authored-by: Loren Gordon --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 75c073b..5de6c40 100644 --- a/README.md +++ b/README.md @@ -20,8 +20,9 @@ To use this template: * `COLLABORATORS and TEAMS` * `Manage Access` * Add relevant team roles, for example - * `tardigrade-admins` (as admin) - * `terraform` (as maintainer) + * `tardigrade-admins` (Admin) + * `terraform` (Write) + * `releasebot` (Write) * `Branches` * `Create Branch Protection rule` for `main` * Turn on Require pull request before merging